@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.d.ts
CHANGED
|
@@ -351,6 +351,55 @@ export type AgentClassification = {
|
|
|
351
351
|
*/
|
|
352
352
|
learned_from?: string | null;
|
|
353
353
|
};
|
|
354
|
+
/**
|
|
355
|
+
* AllocationOverrideResponse
|
|
356
|
+
*
|
|
357
|
+
* A member's allocation override for one month.
|
|
358
|
+
*/
|
|
359
|
+
export type AllocationOverrideResponse = {
|
|
360
|
+
/**
|
|
361
|
+
* Entity Id
|
|
362
|
+
*
|
|
363
|
+
* The member.
|
|
364
|
+
*/
|
|
365
|
+
entity_id: string;
|
|
366
|
+
/**
|
|
367
|
+
* Period
|
|
368
|
+
*
|
|
369
|
+
* The month, as YYYY-MM.
|
|
370
|
+
*/
|
|
371
|
+
period: string;
|
|
372
|
+
/**
|
|
373
|
+
* Amount
|
|
374
|
+
*
|
|
375
|
+
* The share, in cents, when set so.
|
|
376
|
+
*/
|
|
377
|
+
amount?: number | null;
|
|
378
|
+
/**
|
|
379
|
+
* Percentage
|
|
380
|
+
*
|
|
381
|
+
* The share as a percentage, when set so.
|
|
382
|
+
*/
|
|
383
|
+
percentage?: number | null;
|
|
384
|
+
/**
|
|
385
|
+
* Basis
|
|
386
|
+
*
|
|
387
|
+
* Why it differs from pro rata.
|
|
388
|
+
*/
|
|
389
|
+
basis?: string | null;
|
|
390
|
+
/**
|
|
391
|
+
* Set By
|
|
392
|
+
*
|
|
393
|
+
* Who set it.
|
|
394
|
+
*/
|
|
395
|
+
set_by?: string | null;
|
|
396
|
+
/**
|
|
397
|
+
* Cleared
|
|
398
|
+
*
|
|
399
|
+
* True when the override was removed.
|
|
400
|
+
*/
|
|
401
|
+
cleared?: boolean;
|
|
402
|
+
};
|
|
354
403
|
/**
|
|
355
404
|
* AnalyticalStatementFactRow
|
|
356
405
|
*
|
|
@@ -953,6 +1002,12 @@ export type BackfillPlanHistoryOperation = {
|
|
|
953
1002
|
* 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.
|
|
954
1003
|
*/
|
|
955
1004
|
allow_unreconciled_accounts?: boolean;
|
|
1005
|
+
/**
|
|
1006
|
+
* Allow Unexplained Residuals
|
|
1007
|
+
*
|
|
1008
|
+
* Override the group close's residual gate on each reclose of the consolidation entity's months.
|
|
1009
|
+
*/
|
|
1010
|
+
allow_unexplained_residuals?: boolean;
|
|
956
1011
|
/**
|
|
957
1012
|
* Restamp
|
|
958
1013
|
*
|
|
@@ -1952,6 +2007,12 @@ export type ClosePeriodOperation = {
|
|
|
1952
2007
|
* 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.
|
|
1953
2008
|
*/
|
|
1954
2009
|
allow_unreconciled_accounts?: boolean;
|
|
2010
|
+
/**
|
|
2011
|
+
* Allow Unexplained Residuals
|
|
2012
|
+
*
|
|
2013
|
+
* 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.
|
|
2014
|
+
*/
|
|
2015
|
+
allow_unexplained_residuals?: boolean;
|
|
1955
2016
|
/**
|
|
1956
2017
|
* Period
|
|
1957
2018
|
*
|
|
@@ -2532,6 +2593,174 @@ export type ConnectionResponse = {
|
|
|
2532
2593
|
[key: string]: unknown;
|
|
2533
2594
|
};
|
|
2534
2595
|
};
|
|
2596
|
+
/**
|
|
2597
|
+
* ConsolidationProposal
|
|
2598
|
+
*
|
|
2599
|
+
* One consolidating entry the month needs: the difference between the
|
|
2600
|
+
* balance this kind of adjustment should hold for the member at the month
|
|
2601
|
+
* end and what the consolidation entity already holds for it.
|
|
2602
|
+
*/
|
|
2603
|
+
export type ConsolidationProposal = {
|
|
2604
|
+
/**
|
|
2605
|
+
* Adjustment Kind
|
|
2606
|
+
*
|
|
2607
|
+
* What the entry adjusts.
|
|
2608
|
+
*/
|
|
2609
|
+
adjustment_kind: 'elimination_investment' | 'elimination_intercompany' | 'elimination_unrealized_profit' | 'nci_allocation' | 'nci_distribution' | 'equity_method_pickup' | 'equity_method_distribution' | 'acquisition' | 'deconsolidation' | 'translation' | 'manual';
|
|
2610
|
+
/**
|
|
2611
|
+
* Adjusts Entity Id
|
|
2612
|
+
*
|
|
2613
|
+
* The entity whose figures the entry adjusts.
|
|
2614
|
+
*/
|
|
2615
|
+
adjusts_entity_id: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* Adjusts Entity Name
|
|
2618
|
+
*
|
|
2619
|
+
* That entity's name.
|
|
2620
|
+
*/
|
|
2621
|
+
adjusts_entity_name: string;
|
|
2622
|
+
/**
|
|
2623
|
+
* Posting Date
|
|
2624
|
+
*
|
|
2625
|
+
* The month's last day.
|
|
2626
|
+
*/
|
|
2627
|
+
posting_date: string;
|
|
2628
|
+
/**
|
|
2629
|
+
* Memo
|
|
2630
|
+
*
|
|
2631
|
+
* The entry's memo.
|
|
2632
|
+
*/
|
|
2633
|
+
memo: string;
|
|
2634
|
+
/**
|
|
2635
|
+
* Basis
|
|
2636
|
+
*
|
|
2637
|
+
* How the amounts were computed.
|
|
2638
|
+
*/
|
|
2639
|
+
basis: string;
|
|
2640
|
+
/**
|
|
2641
|
+
* Lines
|
|
2642
|
+
*
|
|
2643
|
+
* The entry's lines; they balance.
|
|
2644
|
+
*/
|
|
2645
|
+
lines: Array<ConsolidationProposalLine>;
|
|
2646
|
+
};
|
|
2647
|
+
/**
|
|
2648
|
+
* ConsolidationProposalLine
|
|
2649
|
+
*
|
|
2650
|
+
* One line of a proposed consolidating entry, in the consolidation
|
|
2651
|
+
* entity's chart.
|
|
2652
|
+
*/
|
|
2653
|
+
export type ConsolidationProposalLine = {
|
|
2654
|
+
/**
|
|
2655
|
+
* Element Id
|
|
2656
|
+
*
|
|
2657
|
+
* The consolidation entity's account.
|
|
2658
|
+
*/
|
|
2659
|
+
element_id: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* Account Name
|
|
2662
|
+
*
|
|
2663
|
+
* The account's name.
|
|
2664
|
+
*/
|
|
2665
|
+
account_name: string;
|
|
2666
|
+
/**
|
|
2667
|
+
* Concept
|
|
2668
|
+
*
|
|
2669
|
+
* The rs-gaap concept the account maps to.
|
|
2670
|
+
*/
|
|
2671
|
+
concept: string;
|
|
2672
|
+
/**
|
|
2673
|
+
* Debit Amount
|
|
2674
|
+
*
|
|
2675
|
+
* Debit, in cents.
|
|
2676
|
+
*/
|
|
2677
|
+
debit_amount?: number;
|
|
2678
|
+
/**
|
|
2679
|
+
* Credit Amount
|
|
2680
|
+
*
|
|
2681
|
+
* Credit, in cents.
|
|
2682
|
+
*/
|
|
2683
|
+
credit_amount?: number;
|
|
2684
|
+
/**
|
|
2685
|
+
* Flow Qname
|
|
2686
|
+
*
|
|
2687
|
+
* 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.
|
|
2688
|
+
*/
|
|
2689
|
+
flow_qname?: string | null;
|
|
2690
|
+
};
|
|
2691
|
+
/**
|
|
2692
|
+
* ConsolidationReconcilingItem
|
|
2693
|
+
*
|
|
2694
|
+
* Two of the group's entities whose intercompany figures do not agree.
|
|
2695
|
+
* The lower amount is eliminated where one side matches the other; what is
|
|
2696
|
+
* left stays in the consolidated statements until the books agree.
|
|
2697
|
+
*/
|
|
2698
|
+
export type ConsolidationReconcilingItem = {
|
|
2699
|
+
/**
|
|
2700
|
+
* Entity Ids
|
|
2701
|
+
*
|
|
2702
|
+
* The two entities.
|
|
2703
|
+
*/
|
|
2704
|
+
entity_ids: Array<string>;
|
|
2705
|
+
/**
|
|
2706
|
+
* Concept
|
|
2707
|
+
*
|
|
2708
|
+
* The rs-gaap concept left uneliminated.
|
|
2709
|
+
*/
|
|
2710
|
+
concept: string;
|
|
2711
|
+
/**
|
|
2712
|
+
* Entity Id
|
|
2713
|
+
*
|
|
2714
|
+
* The entity whose figure is left.
|
|
2715
|
+
*/
|
|
2716
|
+
entity_id: string;
|
|
2717
|
+
/**
|
|
2718
|
+
* Amount
|
|
2719
|
+
*
|
|
2720
|
+
* Cents left uneliminated, debit-positive.
|
|
2721
|
+
*/
|
|
2722
|
+
amount: number;
|
|
2723
|
+
/**
|
|
2724
|
+
* Description
|
|
2725
|
+
*
|
|
2726
|
+
* What does not agree.
|
|
2727
|
+
*/
|
|
2728
|
+
description: string;
|
|
2729
|
+
};
|
|
2730
|
+
/**
|
|
2731
|
+
* ConsolidationResidual
|
|
2732
|
+
*
|
|
2733
|
+
* A difference the engine cannot eliminate on its own: the parent's
|
|
2734
|
+
* investment in a member against the parent's share of that member's
|
|
2735
|
+
* capital. Its entry is withheld until the difference is explained or
|
|
2736
|
+
* posted by hand with a basis; it is never plugged.
|
|
2737
|
+
*/
|
|
2738
|
+
export type ConsolidationResidual = {
|
|
2739
|
+
/**
|
|
2740
|
+
* Entity Id
|
|
2741
|
+
*
|
|
2742
|
+
* The member.
|
|
2743
|
+
*/
|
|
2744
|
+
entity_id: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* Entity Name
|
|
2747
|
+
*
|
|
2748
|
+
* The member's name.
|
|
2749
|
+
*/
|
|
2750
|
+
entity_name: string;
|
|
2751
|
+
/**
|
|
2752
|
+
* Amount
|
|
2753
|
+
*
|
|
2754
|
+
* Cents: the parent's investment balance less its share of the member's capital. Positive when the parent carries more than its share.
|
|
2755
|
+
*/
|
|
2756
|
+
amount: number;
|
|
2757
|
+
/**
|
|
2758
|
+
* Explanation
|
|
2759
|
+
*
|
|
2760
|
+
* What the two figures are.
|
|
2761
|
+
*/
|
|
2762
|
+
explanation: string;
|
|
2763
|
+
};
|
|
2535
2764
|
/**
|
|
2536
2765
|
* ConsolidationWorksheetRequest
|
|
2537
2766
|
*
|
|
@@ -6766,7 +6995,7 @@ export type FiscalCalendarResponse = {
|
|
|
6766
6995
|
/**
|
|
6767
6996
|
* Blockers
|
|
6768
6997
|
*
|
|
6769
|
-
* 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'
|
|
6998
|
+
* 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'
|
|
6770
6999
|
*/
|
|
6771
7000
|
blockers?: Array<string>;
|
|
6772
7001
|
/**
|
|
@@ -6841,6 +7070,30 @@ export type FiscalCalendarResponse = {
|
|
|
6841
7070
|
* Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
|
|
6842
7071
|
*/
|
|
6843
7072
|
unreconciled_account_sample?: Array<string>;
|
|
7073
|
+
/**
|
|
7074
|
+
* Group Open Entities
|
|
7075
|
+
*
|
|
7076
|
+
* The group close: the entities the month consolidates, the parent and its equity-method members included, that have not closed it. Close each first.
|
|
7077
|
+
*/
|
|
7078
|
+
group_open_entities?: Array<string>;
|
|
7079
|
+
/**
|
|
7080
|
+
* Group Pending Adjustments
|
|
7081
|
+
*
|
|
7082
|
+
* 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.
|
|
7083
|
+
*/
|
|
7084
|
+
group_pending_adjustments?: Array<string>;
|
|
7085
|
+
/**
|
|
7086
|
+
* Group Unexplained
|
|
7087
|
+
*
|
|
7088
|
+
* 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.
|
|
7089
|
+
*/
|
|
7090
|
+
group_unexplained?: Array<string>;
|
|
7091
|
+
/**
|
|
7092
|
+
* Group Not Footing
|
|
7093
|
+
*
|
|
7094
|
+
* The group close: the consolidated balance sheet's and equity statement's validation failures for the month.
|
|
7095
|
+
*/
|
|
7096
|
+
group_not_footing?: Array<string>;
|
|
6844
7097
|
/**
|
|
6845
7098
|
* Last Close At
|
|
6846
7099
|
*/
|
|
@@ -8874,7 +9127,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8874
9127
|
/**
|
|
8875
9128
|
* Flow Qname
|
|
8876
9129
|
*
|
|
8877
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. On the group's consolidation entity, which moves no cash, every tagged line counts on its own, cash-effect signed (a credit is an inflow), so an elimination offsets the flow a member's line produced. Refused when it is not a row of the entity's cash flow statement.
|
|
9130
|
+
* 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.
|
|
8878
9131
|
*/
|
|
8879
9132
|
flow_qname?: string | null;
|
|
8880
9133
|
/**
|
|
@@ -8977,6 +9230,14 @@ export type JournalEntryResponse = {
|
|
|
8977
9230
|
* Total Credit
|
|
8978
9231
|
*/
|
|
8979
9232
|
total_credit: number;
|
|
9233
|
+
/**
|
|
9234
|
+
* Adjustment Kind
|
|
9235
|
+
*/
|
|
9236
|
+
adjustment_kind?: string | null;
|
|
9237
|
+
/**
|
|
9238
|
+
* Adjusts Entity Id
|
|
9239
|
+
*/
|
|
9240
|
+
adjusts_entity_id?: string | null;
|
|
8980
9241
|
};
|
|
8981
9242
|
/**
|
|
8982
9243
|
* LearnClassificationDefaultsRequest
|
|
@@ -10957,6 +11218,51 @@ export type OperationEnvelopeAcceptSuggestionsResponse = {
|
|
|
10957
11218
|
*/
|
|
10958
11219
|
idempotentReplay?: boolean;
|
|
10959
11220
|
};
|
|
11221
|
+
/**
|
|
11222
|
+
* OperationEnvelope[AllocationOverrideResponse]
|
|
11223
|
+
*/
|
|
11224
|
+
export type OperationEnvelopeAllocationOverrideResponse = {
|
|
11225
|
+
/**
|
|
11226
|
+
* Operation
|
|
11227
|
+
*
|
|
11228
|
+
* Kebab-case operation name
|
|
11229
|
+
*/
|
|
11230
|
+
operation: string;
|
|
11231
|
+
/**
|
|
11232
|
+
* Operationid
|
|
11233
|
+
*
|
|
11234
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11235
|
+
*/
|
|
11236
|
+
operationId: string;
|
|
11237
|
+
/**
|
|
11238
|
+
* Status
|
|
11239
|
+
*
|
|
11240
|
+
* Operation lifecycle state
|
|
11241
|
+
*/
|
|
11242
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11243
|
+
/**
|
|
11244
|
+
* Command-specific result payload
|
|
11245
|
+
*/
|
|
11246
|
+
result?: AllocationOverrideResponse | null;
|
|
11247
|
+
/**
|
|
11248
|
+
* At
|
|
11249
|
+
*
|
|
11250
|
+
* ISO-8601 UTC timestamp
|
|
11251
|
+
*/
|
|
11252
|
+
at: string;
|
|
11253
|
+
/**
|
|
11254
|
+
* Createdby
|
|
11255
|
+
*
|
|
11256
|
+
* User ID that initiated the operation
|
|
11257
|
+
*/
|
|
11258
|
+
createdBy?: string | null;
|
|
11259
|
+
/**
|
|
11260
|
+
* Idempotentreplay
|
|
11261
|
+
*
|
|
11262
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11263
|
+
*/
|
|
11264
|
+
idempotentReplay?: boolean;
|
|
11265
|
+
};
|
|
10960
11266
|
/**
|
|
10961
11267
|
* OperationEnvelope[AssertMetricsResponse]
|
|
10962
11268
|
*/
|
|
@@ -12622,6 +12928,51 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
|
|
|
12622
12928
|
*/
|
|
12623
12929
|
idempotentReplay?: boolean;
|
|
12624
12930
|
};
|
|
12931
|
+
/**
|
|
12932
|
+
* OperationEnvelope[PreviewConsolidationEntriesResponse]
|
|
12933
|
+
*/
|
|
12934
|
+
export type OperationEnvelopePreviewConsolidationEntriesResponse = {
|
|
12935
|
+
/**
|
|
12936
|
+
* Operation
|
|
12937
|
+
*
|
|
12938
|
+
* Kebab-case operation name
|
|
12939
|
+
*/
|
|
12940
|
+
operation: string;
|
|
12941
|
+
/**
|
|
12942
|
+
* Operationid
|
|
12943
|
+
*
|
|
12944
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
12945
|
+
*/
|
|
12946
|
+
operationId: string;
|
|
12947
|
+
/**
|
|
12948
|
+
* Status
|
|
12949
|
+
*
|
|
12950
|
+
* Operation lifecycle state
|
|
12951
|
+
*/
|
|
12952
|
+
status: 'completed' | 'pending' | 'failed';
|
|
12953
|
+
/**
|
|
12954
|
+
* Command-specific result payload
|
|
12955
|
+
*/
|
|
12956
|
+
result?: PreviewConsolidationEntriesResponse | null;
|
|
12957
|
+
/**
|
|
12958
|
+
* At
|
|
12959
|
+
*
|
|
12960
|
+
* ISO-8601 UTC timestamp
|
|
12961
|
+
*/
|
|
12962
|
+
at: string;
|
|
12963
|
+
/**
|
|
12964
|
+
* Createdby
|
|
12965
|
+
*
|
|
12966
|
+
* User ID that initiated the operation
|
|
12967
|
+
*/
|
|
12968
|
+
createdBy?: string | null;
|
|
12969
|
+
/**
|
|
12970
|
+
* Idempotentreplay
|
|
12971
|
+
*
|
|
12972
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
12973
|
+
*/
|
|
12974
|
+
idempotentReplay?: boolean;
|
|
12975
|
+
};
|
|
12625
12976
|
/**
|
|
12626
12977
|
* OperationEnvelope[PreviewEventBlockResponse]
|
|
12627
12978
|
*/
|
|
@@ -12713,9 +13064,9 @@ export type OperationEnvelopePromoteObligationsResponse = {
|
|
|
12713
13064
|
idempotentReplay?: boolean;
|
|
12714
13065
|
};
|
|
12715
13066
|
/**
|
|
12716
|
-
* OperationEnvelope[
|
|
13067
|
+
* OperationEnvelope[ProposeConsolidationEntriesResponse]
|
|
12717
13068
|
*/
|
|
12718
|
-
export type
|
|
13069
|
+
export type OperationEnvelopeProposeConsolidationEntriesResponse = {
|
|
12719
13070
|
/**
|
|
12720
13071
|
* Operation
|
|
12721
13072
|
*
|
|
@@ -12737,7 +13088,7 @@ export type OperationEnvelopePublishListResponse = {
|
|
|
12737
13088
|
/**
|
|
12738
13089
|
* Command-specific result payload
|
|
12739
13090
|
*/
|
|
12740
|
-
result?:
|
|
13091
|
+
result?: ProposeConsolidationEntriesResponse | null;
|
|
12741
13092
|
/**
|
|
12742
13093
|
* At
|
|
12743
13094
|
*
|
|
@@ -12758,9 +13109,54 @@ export type OperationEnvelopePublishListResponse = {
|
|
|
12758
13109
|
idempotentReplay?: boolean;
|
|
12759
13110
|
};
|
|
12760
13111
|
/**
|
|
12761
|
-
* OperationEnvelope[
|
|
13112
|
+
* OperationEnvelope[PublishListResponse]
|
|
12762
13113
|
*/
|
|
12763
|
-
export type
|
|
13114
|
+
export type OperationEnvelopePublishListResponse = {
|
|
13115
|
+
/**
|
|
13116
|
+
* Operation
|
|
13117
|
+
*
|
|
13118
|
+
* Kebab-case operation name
|
|
13119
|
+
*/
|
|
13120
|
+
operation: string;
|
|
13121
|
+
/**
|
|
13122
|
+
* Operationid
|
|
13123
|
+
*
|
|
13124
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
13125
|
+
*/
|
|
13126
|
+
operationId: string;
|
|
13127
|
+
/**
|
|
13128
|
+
* Status
|
|
13129
|
+
*
|
|
13130
|
+
* Operation lifecycle state
|
|
13131
|
+
*/
|
|
13132
|
+
status: 'completed' | 'pending' | 'failed';
|
|
13133
|
+
/**
|
|
13134
|
+
* Command-specific result payload
|
|
13135
|
+
*/
|
|
13136
|
+
result?: PublishListResponse | null;
|
|
13137
|
+
/**
|
|
13138
|
+
* At
|
|
13139
|
+
*
|
|
13140
|
+
* ISO-8601 UTC timestamp
|
|
13141
|
+
*/
|
|
13142
|
+
at: string;
|
|
13143
|
+
/**
|
|
13144
|
+
* Createdby
|
|
13145
|
+
*
|
|
13146
|
+
* User ID that initiated the operation
|
|
13147
|
+
*/
|
|
13148
|
+
createdBy?: string | null;
|
|
13149
|
+
/**
|
|
13150
|
+
* Idempotentreplay
|
|
13151
|
+
*
|
|
13152
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
13153
|
+
*/
|
|
13154
|
+
idempotentReplay?: boolean;
|
|
13155
|
+
};
|
|
13156
|
+
/**
|
|
13157
|
+
* OperationEnvelope[ReadTextResponse]
|
|
13158
|
+
*/
|
|
13159
|
+
export type OperationEnvelopeReadTextResponse = {
|
|
12764
13160
|
/**
|
|
12765
13161
|
* Operation
|
|
12766
13162
|
*
|
|
@@ -14985,6 +15381,92 @@ export type PositionBlock = {
|
|
|
14985
15381
|
*/
|
|
14986
15382
|
security: SecurityLite;
|
|
14987
15383
|
};
|
|
15384
|
+
/**
|
|
15385
|
+
* PreviewConsolidationEntriesRequest
|
|
15386
|
+
*
|
|
15387
|
+
* The month to compute the consolidating entries for.
|
|
15388
|
+
*/
|
|
15389
|
+
export type PreviewConsolidationEntriesRequest = {
|
|
15390
|
+
/**
|
|
15391
|
+
* Period
|
|
15392
|
+
*
|
|
15393
|
+
* The month, as YYYY-MM.
|
|
15394
|
+
*/
|
|
15395
|
+
period: string;
|
|
15396
|
+
};
|
|
15397
|
+
/**
|
|
15398
|
+
* PreviewConsolidationEntriesResponse
|
|
15399
|
+
*
|
|
15400
|
+
* The consolidating entries a month needs, computed from the books.
|
|
15401
|
+
*/
|
|
15402
|
+
export type PreviewConsolidationEntriesResponse = {
|
|
15403
|
+
/**
|
|
15404
|
+
* Period
|
|
15405
|
+
*
|
|
15406
|
+
* The month, as YYYY-MM.
|
|
15407
|
+
*/
|
|
15408
|
+
period: string;
|
|
15409
|
+
/**
|
|
15410
|
+
* Period Start
|
|
15411
|
+
*
|
|
15412
|
+
* The month's first day.
|
|
15413
|
+
*/
|
|
15414
|
+
period_start: string;
|
|
15415
|
+
/**
|
|
15416
|
+
* Period End
|
|
15417
|
+
*
|
|
15418
|
+
* The month's last day.
|
|
15419
|
+
*/
|
|
15420
|
+
period_end: string;
|
|
15421
|
+
/**
|
|
15422
|
+
* Consolidation Entity Id
|
|
15423
|
+
*
|
|
15424
|
+
* The entity the entries post in.
|
|
15425
|
+
*/
|
|
15426
|
+
consolidation_entity_id: string;
|
|
15427
|
+
/**
|
|
15428
|
+
* Proposals
|
|
15429
|
+
*
|
|
15430
|
+
* The entries to post; empty when the month is up to date.
|
|
15431
|
+
*/
|
|
15432
|
+
proposals?: Array<ConsolidationProposal>;
|
|
15433
|
+
/**
|
|
15434
|
+
* Residuals
|
|
15435
|
+
*
|
|
15436
|
+
* Differences withheld from the proposals until explained.
|
|
15437
|
+
*/
|
|
15438
|
+
residuals?: Array<ConsolidationResidual>;
|
|
15439
|
+
/**
|
|
15440
|
+
* Reconciling Items
|
|
15441
|
+
*
|
|
15442
|
+
* Intercompany figures the two sides do not agree on.
|
|
15443
|
+
*/
|
|
15444
|
+
reconciling_items?: Array<ConsolidationReconcilingItem>;
|
|
15445
|
+
/**
|
|
15446
|
+
* Notes
|
|
15447
|
+
*
|
|
15448
|
+
* Anything the engine left out, and why.
|
|
15449
|
+
*/
|
|
15450
|
+
notes?: Array<string>;
|
|
15451
|
+
/**
|
|
15452
|
+
* Up To Date
|
|
15453
|
+
*
|
|
15454
|
+
* 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.
|
|
15455
|
+
*/
|
|
15456
|
+
up_to_date: boolean;
|
|
15457
|
+
/**
|
|
15458
|
+
* Closed
|
|
15459
|
+
*
|
|
15460
|
+
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15461
|
+
*/
|
|
15462
|
+
closed?: boolean;
|
|
15463
|
+
/**
|
|
15464
|
+
* Drafted Entry Ids
|
|
15465
|
+
*
|
|
15466
|
+
* The month's drafts propose-consolidation-entries wrote, waiting for the consolidation entity's close to post them.
|
|
15467
|
+
*/
|
|
15468
|
+
drafted_entry_ids?: Array<string>;
|
|
15469
|
+
};
|
|
14988
15470
|
/**
|
|
14989
15471
|
* PreviewEventBlockResponse
|
|
14990
15472
|
*
|
|
@@ -15130,6 +15612,74 @@ export type PromoteObligationsResponse = {
|
|
|
15130
15612
|
[key: string]: string;
|
|
15131
15613
|
}>;
|
|
15132
15614
|
};
|
|
15615
|
+
/**
|
|
15616
|
+
* ProposeConsolidationEntriesRequest
|
|
15617
|
+
*
|
|
15618
|
+
* The month to draft the consolidating entries for.
|
|
15619
|
+
*/
|
|
15620
|
+
export type ProposeConsolidationEntriesRequest = {
|
|
15621
|
+
/**
|
|
15622
|
+
* Period
|
|
15623
|
+
*
|
|
15624
|
+
* The month, as YYYY-MM.
|
|
15625
|
+
*/
|
|
15626
|
+
period: string;
|
|
15627
|
+
};
|
|
15628
|
+
/**
|
|
15629
|
+
* ProposeConsolidationEntriesResponse
|
|
15630
|
+
*
|
|
15631
|
+
* The consolidating entries drafted for a month.
|
|
15632
|
+
*/
|
|
15633
|
+
export type ProposeConsolidationEntriesResponse = {
|
|
15634
|
+
/**
|
|
15635
|
+
* Period
|
|
15636
|
+
*
|
|
15637
|
+
* The month, as YYYY-MM.
|
|
15638
|
+
*/
|
|
15639
|
+
period: string;
|
|
15640
|
+
/**
|
|
15641
|
+
* Consolidation Entity Id
|
|
15642
|
+
*
|
|
15643
|
+
* The entity the drafts are in.
|
|
15644
|
+
*/
|
|
15645
|
+
consolidation_entity_id: string;
|
|
15646
|
+
/**
|
|
15647
|
+
* Closed
|
|
15648
|
+
*
|
|
15649
|
+
* True when the month is closed and nothing was drafted.
|
|
15650
|
+
*/
|
|
15651
|
+
closed?: boolean;
|
|
15652
|
+
/**
|
|
15653
|
+
* Entries
|
|
15654
|
+
*
|
|
15655
|
+
* The drafts written; the consolidation entity's close posts them.
|
|
15656
|
+
*/
|
|
15657
|
+
entries?: Array<JournalEntryResponse>;
|
|
15658
|
+
/**
|
|
15659
|
+
* Replaced
|
|
15660
|
+
*
|
|
15661
|
+
* Earlier drafts of this month's entries, replaced by these.
|
|
15662
|
+
*/
|
|
15663
|
+
replaced?: number;
|
|
15664
|
+
/**
|
|
15665
|
+
* Residuals
|
|
15666
|
+
*
|
|
15667
|
+
* Differences withheld from the drafts until explained.
|
|
15668
|
+
*/
|
|
15669
|
+
residuals?: Array<ConsolidationResidual>;
|
|
15670
|
+
/**
|
|
15671
|
+
* Reconciling Items
|
|
15672
|
+
*
|
|
15673
|
+
* Intercompany figures the two sides do not agree on.
|
|
15674
|
+
*/
|
|
15675
|
+
reconciling_items?: Array<ConsolidationReconcilingItem>;
|
|
15676
|
+
/**
|
|
15677
|
+
* Notes
|
|
15678
|
+
*
|
|
15679
|
+
* Anything the engine left out, and why.
|
|
15680
|
+
*/
|
|
15681
|
+
notes?: Array<string>;
|
|
15682
|
+
};
|
|
15133
15683
|
/**
|
|
15134
15684
|
* PublishListMemberResponse
|
|
15135
15685
|
*
|
|
@@ -18204,6 +18754,51 @@ export type ServiceOfferingsResponse = {
|
|
|
18204
18754
|
*/
|
|
18205
18755
|
summary: ServiceOfferingSummary;
|
|
18206
18756
|
};
|
|
18757
|
+
/**
|
|
18758
|
+
* SetAllocationOverrideRequest
|
|
18759
|
+
*
|
|
18760
|
+
* The outside owners' share of a member's result for one month, set by a
|
|
18761
|
+
* person in place of the pro-rata share: a preferred return, a waterfall, a
|
|
18762
|
+
* special allocation.
|
|
18763
|
+
*/
|
|
18764
|
+
export type SetAllocationOverrideRequest = {
|
|
18765
|
+
/**
|
|
18766
|
+
* Entity Id
|
|
18767
|
+
*
|
|
18768
|
+
* The member, consolidated in full.
|
|
18769
|
+
*/
|
|
18770
|
+
entity_id: string;
|
|
18771
|
+
/**
|
|
18772
|
+
* Period
|
|
18773
|
+
*
|
|
18774
|
+
* The month, as YYYY-MM.
|
|
18775
|
+
*/
|
|
18776
|
+
period: string;
|
|
18777
|
+
/**
|
|
18778
|
+
* Amount
|
|
18779
|
+
*
|
|
18780
|
+
* The outside owners' share of the month's result, in cents; negative for a share of a loss.
|
|
18781
|
+
*/
|
|
18782
|
+
amount?: number | null;
|
|
18783
|
+
/**
|
|
18784
|
+
* Percentage
|
|
18785
|
+
*
|
|
18786
|
+
* The outside owners' share as a percentage of the month's result.
|
|
18787
|
+
*/
|
|
18788
|
+
percentage?: number | null;
|
|
18789
|
+
/**
|
|
18790
|
+
* Basis
|
|
18791
|
+
*
|
|
18792
|
+
* Why the share differs from the ownership percentage; required to set one.
|
|
18793
|
+
*/
|
|
18794
|
+
basis?: string | null;
|
|
18795
|
+
/**
|
|
18796
|
+
* Clear
|
|
18797
|
+
*
|
|
18798
|
+
* Remove the month's override, back to the pro-rata share.
|
|
18799
|
+
*/
|
|
18800
|
+
clear?: boolean;
|
|
18801
|
+
};
|
|
18207
18802
|
/**
|
|
18208
18803
|
* SetCloseTargetOperation
|
|
18209
18804
|
*/
|
|
@@ -30996,6 +31591,124 @@ export type RecordOpeningBalanceResponses = {
|
|
|
30996
31591
|
200: OperationEnvelopeJournalEntryResponse;
|
|
30997
31592
|
};
|
|
30998
31593
|
export type RecordOpeningBalanceResponse = RecordOpeningBalanceResponses[keyof RecordOpeningBalanceResponses];
|
|
31594
|
+
export type ProposeConsolidationEntriesData = {
|
|
31595
|
+
body: ProposeConsolidationEntriesRequest;
|
|
31596
|
+
headers?: {
|
|
31597
|
+
/**
|
|
31598
|
+
* Idempotency-Key
|
|
31599
|
+
*/
|
|
31600
|
+
'Idempotency-Key'?: string | null;
|
|
31601
|
+
};
|
|
31602
|
+
path: {
|
|
31603
|
+
/**
|
|
31604
|
+
* Graph Id
|
|
31605
|
+
*/
|
|
31606
|
+
graph_id: string;
|
|
31607
|
+
};
|
|
31608
|
+
query?: never;
|
|
31609
|
+
url: '/extensions/roboledger/{graph_id}/operations/propose-consolidation-entries';
|
|
31610
|
+
};
|
|
31611
|
+
export type ProposeConsolidationEntriesErrors = {
|
|
31612
|
+
/**
|
|
31613
|
+
* Invalid request
|
|
31614
|
+
*/
|
|
31615
|
+
400: ErrorResponse;
|
|
31616
|
+
/**
|
|
31617
|
+
* Authentication required
|
|
31618
|
+
*/
|
|
31619
|
+
401: ErrorResponse;
|
|
31620
|
+
/**
|
|
31621
|
+
* Access denied
|
|
31622
|
+
*/
|
|
31623
|
+
403: ErrorResponse;
|
|
31624
|
+
/**
|
|
31625
|
+
* Resource not found
|
|
31626
|
+
*/
|
|
31627
|
+
404: ErrorResponse;
|
|
31628
|
+
/**
|
|
31629
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31630
|
+
*/
|
|
31631
|
+
409: ErrorResponse;
|
|
31632
|
+
/**
|
|
31633
|
+
* Validation error
|
|
31634
|
+
*/
|
|
31635
|
+
422: ErrorResponse;
|
|
31636
|
+
/**
|
|
31637
|
+
* Rate limit exceeded
|
|
31638
|
+
*/
|
|
31639
|
+
429: ErrorResponse;
|
|
31640
|
+
/**
|
|
31641
|
+
* Internal server error
|
|
31642
|
+
*/
|
|
31643
|
+
500: ErrorResponse;
|
|
31644
|
+
};
|
|
31645
|
+
export type ProposeConsolidationEntriesError = ProposeConsolidationEntriesErrors[keyof ProposeConsolidationEntriesErrors];
|
|
31646
|
+
export type ProposeConsolidationEntriesResponses = {
|
|
31647
|
+
/**
|
|
31648
|
+
* Successful Response
|
|
31649
|
+
*/
|
|
31650
|
+
200: OperationEnvelopeProposeConsolidationEntriesResponse;
|
|
31651
|
+
};
|
|
31652
|
+
export type ProposeConsolidationEntriesResponse2 = ProposeConsolidationEntriesResponses[keyof ProposeConsolidationEntriesResponses];
|
|
31653
|
+
export type SetAllocationOverrideData = {
|
|
31654
|
+
body: SetAllocationOverrideRequest;
|
|
31655
|
+
headers?: {
|
|
31656
|
+
/**
|
|
31657
|
+
* Idempotency-Key
|
|
31658
|
+
*/
|
|
31659
|
+
'Idempotency-Key'?: string | null;
|
|
31660
|
+
};
|
|
31661
|
+
path: {
|
|
31662
|
+
/**
|
|
31663
|
+
* Graph Id
|
|
31664
|
+
*/
|
|
31665
|
+
graph_id: string;
|
|
31666
|
+
};
|
|
31667
|
+
query?: never;
|
|
31668
|
+
url: '/extensions/roboledger/{graph_id}/operations/set-allocation-override';
|
|
31669
|
+
};
|
|
31670
|
+
export type SetAllocationOverrideErrors = {
|
|
31671
|
+
/**
|
|
31672
|
+
* Invalid request
|
|
31673
|
+
*/
|
|
31674
|
+
400: ErrorResponse;
|
|
31675
|
+
/**
|
|
31676
|
+
* Authentication required
|
|
31677
|
+
*/
|
|
31678
|
+
401: ErrorResponse;
|
|
31679
|
+
/**
|
|
31680
|
+
* Access denied
|
|
31681
|
+
*/
|
|
31682
|
+
403: ErrorResponse;
|
|
31683
|
+
/**
|
|
31684
|
+
* Resource not found
|
|
31685
|
+
*/
|
|
31686
|
+
404: ErrorResponse;
|
|
31687
|
+
/**
|
|
31688
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31689
|
+
*/
|
|
31690
|
+
409: ErrorResponse;
|
|
31691
|
+
/**
|
|
31692
|
+
* Validation error
|
|
31693
|
+
*/
|
|
31694
|
+
422: ErrorResponse;
|
|
31695
|
+
/**
|
|
31696
|
+
* Rate limit exceeded
|
|
31697
|
+
*/
|
|
31698
|
+
429: ErrorResponse;
|
|
31699
|
+
/**
|
|
31700
|
+
* Internal server error
|
|
31701
|
+
*/
|
|
31702
|
+
500: ErrorResponse;
|
|
31703
|
+
};
|
|
31704
|
+
export type SetAllocationOverrideError = SetAllocationOverrideErrors[keyof SetAllocationOverrideErrors];
|
|
31705
|
+
export type SetAllocationOverrideResponses = {
|
|
31706
|
+
/**
|
|
31707
|
+
* Successful Response
|
|
31708
|
+
*/
|
|
31709
|
+
200: OperationEnvelopeAllocationOverrideResponse;
|
|
31710
|
+
};
|
|
31711
|
+
export type SetAllocationOverrideResponse = SetAllocationOverrideResponses[keyof SetAllocationOverrideResponses];
|
|
30999
31712
|
export type UpdateJournalEntryData = {
|
|
31000
31713
|
body: UpdateJournalEntryRequest;
|
|
31001
31714
|
headers?: {
|
|
@@ -32884,6 +33597,65 @@ export type ConsolidationWorksheetResponses = {
|
|
|
32884
33597
|
200: OperationEnvelopeConsolidationWorksheetResponse;
|
|
32885
33598
|
};
|
|
32886
33599
|
export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
|
|
33600
|
+
export type PreviewConsolidationEntriesData = {
|
|
33601
|
+
body: PreviewConsolidationEntriesRequest;
|
|
33602
|
+
headers?: {
|
|
33603
|
+
/**
|
|
33604
|
+
* Idempotency-Key
|
|
33605
|
+
*/
|
|
33606
|
+
'Idempotency-Key'?: string | null;
|
|
33607
|
+
};
|
|
33608
|
+
path: {
|
|
33609
|
+
/**
|
|
33610
|
+
* Graph Id
|
|
33611
|
+
*/
|
|
33612
|
+
graph_id: string;
|
|
33613
|
+
};
|
|
33614
|
+
query?: never;
|
|
33615
|
+
url: '/extensions/roboledger/{graph_id}/operations/preview-consolidation-entries';
|
|
33616
|
+
};
|
|
33617
|
+
export type PreviewConsolidationEntriesErrors = {
|
|
33618
|
+
/**
|
|
33619
|
+
* Invalid request
|
|
33620
|
+
*/
|
|
33621
|
+
400: ErrorResponse;
|
|
33622
|
+
/**
|
|
33623
|
+
* Authentication required
|
|
33624
|
+
*/
|
|
33625
|
+
401: ErrorResponse;
|
|
33626
|
+
/**
|
|
33627
|
+
* Access denied
|
|
33628
|
+
*/
|
|
33629
|
+
403: ErrorResponse;
|
|
33630
|
+
/**
|
|
33631
|
+
* Resource not found
|
|
33632
|
+
*/
|
|
33633
|
+
404: ErrorResponse;
|
|
33634
|
+
/**
|
|
33635
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33636
|
+
*/
|
|
33637
|
+
409: ErrorResponse;
|
|
33638
|
+
/**
|
|
33639
|
+
* Validation error
|
|
33640
|
+
*/
|
|
33641
|
+
422: ErrorResponse;
|
|
33642
|
+
/**
|
|
33643
|
+
* Rate limit exceeded
|
|
33644
|
+
*/
|
|
33645
|
+
429: ErrorResponse;
|
|
33646
|
+
/**
|
|
33647
|
+
* Internal server error
|
|
33648
|
+
*/
|
|
33649
|
+
500: ErrorResponse;
|
|
33650
|
+
};
|
|
33651
|
+
export type PreviewConsolidationEntriesError = PreviewConsolidationEntriesErrors[keyof PreviewConsolidationEntriesErrors];
|
|
33652
|
+
export type PreviewConsolidationEntriesResponses = {
|
|
33653
|
+
/**
|
|
33654
|
+
* Successful Response
|
|
33655
|
+
*/
|
|
33656
|
+
200: OperationEnvelopePreviewConsolidationEntriesResponse;
|
|
33657
|
+
};
|
|
33658
|
+
export type PreviewConsolidationEntriesResponse2 = PreviewConsolidationEntriesResponses[keyof PreviewConsolidationEntriesResponses];
|
|
32887
33659
|
export type CreatePortfolioBlockData = {
|
|
32888
33660
|
body: CreatePortfolioBlockRequest;
|
|
32889
33661
|
headers?: {
|