@robosystems/client 2.17.0 → 2.19.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 +34 -1
- package/artifacts/LedgerClient.js +45 -0
- package/artifacts/LedgerClient.ts +78 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +6 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +33 -1
- package/sdk/sdk.gen.js +70 -2
- package/sdk/sdk.gen.ts +69 -1
- package/sdk/types.gen.d.ts +860 -1
- package/sdk/types.gen.ts +937 -43
- package/sdk.gen.d.ts +33 -1
- package/sdk.gen.js +70 -2
- package/sdk.gen.ts +69 -1
- package/types.gen.d.ts +860 -1
- package/types.gen.ts +937 -43
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
|
*
|
|
@@ -2532,6 +2581,174 @@ export type ConnectionResponse = {
|
|
|
2532
2581
|
[key: string]: unknown;
|
|
2533
2582
|
};
|
|
2534
2583
|
};
|
|
2584
|
+
/**
|
|
2585
|
+
* ConsolidationProposal
|
|
2586
|
+
*
|
|
2587
|
+
* One consolidating entry the month needs: the difference between the
|
|
2588
|
+
* balance this kind of adjustment should hold for the member at the month
|
|
2589
|
+
* end and what the consolidation entity already holds for it.
|
|
2590
|
+
*/
|
|
2591
|
+
export type ConsolidationProposal = {
|
|
2592
|
+
/**
|
|
2593
|
+
* Adjustment Kind
|
|
2594
|
+
*
|
|
2595
|
+
* What the entry adjusts.
|
|
2596
|
+
*/
|
|
2597
|
+
adjustment_kind: 'elimination_investment' | 'elimination_intercompany' | 'elimination_unrealized_profit' | 'nci_allocation' | 'nci_distribution' | 'equity_method_pickup' | 'equity_method_distribution' | 'acquisition' | 'deconsolidation' | 'translation' | 'manual';
|
|
2598
|
+
/**
|
|
2599
|
+
* Adjusts Entity Id
|
|
2600
|
+
*
|
|
2601
|
+
* The entity whose figures the entry adjusts.
|
|
2602
|
+
*/
|
|
2603
|
+
adjusts_entity_id: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* Adjusts Entity Name
|
|
2606
|
+
*
|
|
2607
|
+
* That entity's name.
|
|
2608
|
+
*/
|
|
2609
|
+
adjusts_entity_name: string;
|
|
2610
|
+
/**
|
|
2611
|
+
* Posting Date
|
|
2612
|
+
*
|
|
2613
|
+
* The month's last day.
|
|
2614
|
+
*/
|
|
2615
|
+
posting_date: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* Memo
|
|
2618
|
+
*
|
|
2619
|
+
* The entry's memo.
|
|
2620
|
+
*/
|
|
2621
|
+
memo: string;
|
|
2622
|
+
/**
|
|
2623
|
+
* Basis
|
|
2624
|
+
*
|
|
2625
|
+
* How the amounts were computed.
|
|
2626
|
+
*/
|
|
2627
|
+
basis: string;
|
|
2628
|
+
/**
|
|
2629
|
+
* Lines
|
|
2630
|
+
*
|
|
2631
|
+
* The entry's lines; they balance.
|
|
2632
|
+
*/
|
|
2633
|
+
lines: Array<ConsolidationProposalLine>;
|
|
2634
|
+
};
|
|
2635
|
+
/**
|
|
2636
|
+
* ConsolidationProposalLine
|
|
2637
|
+
*
|
|
2638
|
+
* One line of a proposed consolidating entry, in the consolidation
|
|
2639
|
+
* entity's chart.
|
|
2640
|
+
*/
|
|
2641
|
+
export type ConsolidationProposalLine = {
|
|
2642
|
+
/**
|
|
2643
|
+
* Element Id
|
|
2644
|
+
*
|
|
2645
|
+
* The consolidation entity's account.
|
|
2646
|
+
*/
|
|
2647
|
+
element_id: string;
|
|
2648
|
+
/**
|
|
2649
|
+
* Account Name
|
|
2650
|
+
*
|
|
2651
|
+
* The account's name.
|
|
2652
|
+
*/
|
|
2653
|
+
account_name: string;
|
|
2654
|
+
/**
|
|
2655
|
+
* Concept
|
|
2656
|
+
*
|
|
2657
|
+
* The rs-gaap concept the account maps to.
|
|
2658
|
+
*/
|
|
2659
|
+
concept: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* Debit Amount
|
|
2662
|
+
*
|
|
2663
|
+
* Debit, in cents.
|
|
2664
|
+
*/
|
|
2665
|
+
debit_amount?: number;
|
|
2666
|
+
/**
|
|
2667
|
+
* Credit Amount
|
|
2668
|
+
*
|
|
2669
|
+
* Credit, in cents.
|
|
2670
|
+
*/
|
|
2671
|
+
credit_amount?: number;
|
|
2672
|
+
/**
|
|
2673
|
+
* Flow Qname
|
|
2674
|
+
*
|
|
2675
|
+
* 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.
|
|
2676
|
+
*/
|
|
2677
|
+
flow_qname?: string | null;
|
|
2678
|
+
};
|
|
2679
|
+
/**
|
|
2680
|
+
* ConsolidationReconcilingItem
|
|
2681
|
+
*
|
|
2682
|
+
* Two of the group's entities whose intercompany figures do not agree.
|
|
2683
|
+
* The lower amount is eliminated where one side matches the other; what is
|
|
2684
|
+
* left stays in the consolidated statements until the books agree.
|
|
2685
|
+
*/
|
|
2686
|
+
export type ConsolidationReconcilingItem = {
|
|
2687
|
+
/**
|
|
2688
|
+
* Entity Ids
|
|
2689
|
+
*
|
|
2690
|
+
* The two entities.
|
|
2691
|
+
*/
|
|
2692
|
+
entity_ids: Array<string>;
|
|
2693
|
+
/**
|
|
2694
|
+
* Concept
|
|
2695
|
+
*
|
|
2696
|
+
* The rs-gaap concept left uneliminated.
|
|
2697
|
+
*/
|
|
2698
|
+
concept: string;
|
|
2699
|
+
/**
|
|
2700
|
+
* Entity Id
|
|
2701
|
+
*
|
|
2702
|
+
* The entity whose figure is left.
|
|
2703
|
+
*/
|
|
2704
|
+
entity_id: string;
|
|
2705
|
+
/**
|
|
2706
|
+
* Amount
|
|
2707
|
+
*
|
|
2708
|
+
* Cents left uneliminated, debit-positive.
|
|
2709
|
+
*/
|
|
2710
|
+
amount: number;
|
|
2711
|
+
/**
|
|
2712
|
+
* Description
|
|
2713
|
+
*
|
|
2714
|
+
* What does not agree.
|
|
2715
|
+
*/
|
|
2716
|
+
description: string;
|
|
2717
|
+
};
|
|
2718
|
+
/**
|
|
2719
|
+
* ConsolidationResidual
|
|
2720
|
+
*
|
|
2721
|
+
* A difference the engine cannot eliminate on its own: the parent's
|
|
2722
|
+
* investment in a member against the parent's share of that member's
|
|
2723
|
+
* capital. Its entry is withheld until the difference is explained or
|
|
2724
|
+
* posted by hand with a basis; it is never plugged.
|
|
2725
|
+
*/
|
|
2726
|
+
export type ConsolidationResidual = {
|
|
2727
|
+
/**
|
|
2728
|
+
* Entity Id
|
|
2729
|
+
*
|
|
2730
|
+
* The member.
|
|
2731
|
+
*/
|
|
2732
|
+
entity_id: string;
|
|
2733
|
+
/**
|
|
2734
|
+
* Entity Name
|
|
2735
|
+
*
|
|
2736
|
+
* The member's name.
|
|
2737
|
+
*/
|
|
2738
|
+
entity_name: string;
|
|
2739
|
+
/**
|
|
2740
|
+
* Amount
|
|
2741
|
+
*
|
|
2742
|
+
* Cents: the parent's investment balance less its share of the member's capital. Positive when the parent carries more than its share.
|
|
2743
|
+
*/
|
|
2744
|
+
amount: number;
|
|
2745
|
+
/**
|
|
2746
|
+
* Explanation
|
|
2747
|
+
*
|
|
2748
|
+
* What the two figures are.
|
|
2749
|
+
*/
|
|
2750
|
+
explanation: string;
|
|
2751
|
+
};
|
|
2535
2752
|
/**
|
|
2536
2753
|
* ConsolidationWorksheetRequest
|
|
2537
2754
|
*
|
|
@@ -8874,7 +9091,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8874
9091
|
/**
|
|
8875
9092
|
* Flow Qname
|
|
8876
9093
|
*
|
|
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.
|
|
9094
|
+
* 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
9095
|
*/
|
|
8879
9096
|
flow_qname?: string | null;
|
|
8880
9097
|
/**
|
|
@@ -8977,6 +9194,14 @@ export type JournalEntryResponse = {
|
|
|
8977
9194
|
* Total Credit
|
|
8978
9195
|
*/
|
|
8979
9196
|
total_credit: number;
|
|
9197
|
+
/**
|
|
9198
|
+
* Adjustment Kind
|
|
9199
|
+
*/
|
|
9200
|
+
adjustment_kind?: string | null;
|
|
9201
|
+
/**
|
|
9202
|
+
* Adjusts Entity Id
|
|
9203
|
+
*/
|
|
9204
|
+
adjusts_entity_id?: string | null;
|
|
8980
9205
|
};
|
|
8981
9206
|
/**
|
|
8982
9207
|
* LearnClassificationDefaultsRequest
|
|
@@ -9995,6 +10220,12 @@ export type LiveFinancialStatementResponse = {
|
|
|
9995
10220
|
* Rendered columns, aligned with each row's `values`. Current and prior for income_statement and balance_sheet; current only for cash_flow_statement — the prior period is pivoted as the indirect-method delta basis and not rendered.
|
|
9996
10221
|
*/
|
|
9997
10222
|
periods: Array<PeriodSpec>;
|
|
10223
|
+
/**
|
|
10224
|
+
* Omitted Periods
|
|
10225
|
+
*
|
|
10226
|
+
* Columns left out because they reach back before the books begin: on books that start from an opening balance, a flow statement column that starts before the first day it covers, or a balance sheet dated before it. They would show a partial figure, not the months before the books.
|
|
10227
|
+
*/
|
|
10228
|
+
omitted_periods?: Array<PeriodSpec>;
|
|
9998
10229
|
/**
|
|
9999
10230
|
* Facts
|
|
10000
10231
|
*/
|
|
@@ -10774,6 +11005,33 @@ export type OfferingRepositoryPlan = {
|
|
|
10774
11005
|
[key: string]: number | null;
|
|
10775
11006
|
} | null;
|
|
10776
11007
|
};
|
|
11008
|
+
/**
|
|
11009
|
+
* OpeningBalanceInput
|
|
11010
|
+
*
|
|
11011
|
+
* One account's balance on the day the books begin, in its normal
|
|
11012
|
+
* direction: an asset as a debit, a liability or equity account as a credit
|
|
11013
|
+
* (a contra account the other way).
|
|
11014
|
+
*/
|
|
11015
|
+
export type OpeningBalanceInput = {
|
|
11016
|
+
/**
|
|
11017
|
+
* Element Id
|
|
11018
|
+
*
|
|
11019
|
+
* The balance-sheet account, by id.
|
|
11020
|
+
*/
|
|
11021
|
+
element_id: string;
|
|
11022
|
+
/**
|
|
11023
|
+
* Debit Amount
|
|
11024
|
+
*
|
|
11025
|
+
* Debit balance in cents.
|
|
11026
|
+
*/
|
|
11027
|
+
debit_amount?: number;
|
|
11028
|
+
/**
|
|
11029
|
+
* Credit Amount
|
|
11030
|
+
*
|
|
11031
|
+
* Credit balance in cents.
|
|
11032
|
+
*/
|
|
11033
|
+
credit_amount?: number;
|
|
11034
|
+
};
|
|
10777
11035
|
/**
|
|
10778
11036
|
* OperationCosts
|
|
10779
11037
|
*
|
|
@@ -10924,6 +11182,51 @@ export type OperationEnvelopeAcceptSuggestionsResponse = {
|
|
|
10924
11182
|
*/
|
|
10925
11183
|
idempotentReplay?: boolean;
|
|
10926
11184
|
};
|
|
11185
|
+
/**
|
|
11186
|
+
* OperationEnvelope[AllocationOverrideResponse]
|
|
11187
|
+
*/
|
|
11188
|
+
export type OperationEnvelopeAllocationOverrideResponse = {
|
|
11189
|
+
/**
|
|
11190
|
+
* Operation
|
|
11191
|
+
*
|
|
11192
|
+
* Kebab-case operation name
|
|
11193
|
+
*/
|
|
11194
|
+
operation: string;
|
|
11195
|
+
/**
|
|
11196
|
+
* Operationid
|
|
11197
|
+
*
|
|
11198
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11199
|
+
*/
|
|
11200
|
+
operationId: string;
|
|
11201
|
+
/**
|
|
11202
|
+
* Status
|
|
11203
|
+
*
|
|
11204
|
+
* Operation lifecycle state
|
|
11205
|
+
*/
|
|
11206
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11207
|
+
/**
|
|
11208
|
+
* Command-specific result payload
|
|
11209
|
+
*/
|
|
11210
|
+
result?: AllocationOverrideResponse | null;
|
|
11211
|
+
/**
|
|
11212
|
+
* At
|
|
11213
|
+
*
|
|
11214
|
+
* ISO-8601 UTC timestamp
|
|
11215
|
+
*/
|
|
11216
|
+
at: string;
|
|
11217
|
+
/**
|
|
11218
|
+
* Createdby
|
|
11219
|
+
*
|
|
11220
|
+
* User ID that initiated the operation
|
|
11221
|
+
*/
|
|
11222
|
+
createdBy?: string | null;
|
|
11223
|
+
/**
|
|
11224
|
+
* Idempotentreplay
|
|
11225
|
+
*
|
|
11226
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11227
|
+
*/
|
|
11228
|
+
idempotentReplay?: boolean;
|
|
11229
|
+
};
|
|
10927
11230
|
/**
|
|
10928
11231
|
* OperationEnvelope[AssertMetricsResponse]
|
|
10929
11232
|
*/
|
|
@@ -12589,6 +12892,51 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
|
|
|
12589
12892
|
*/
|
|
12590
12893
|
idempotentReplay?: boolean;
|
|
12591
12894
|
};
|
|
12895
|
+
/**
|
|
12896
|
+
* OperationEnvelope[PreviewConsolidationEntriesResponse]
|
|
12897
|
+
*/
|
|
12898
|
+
export type OperationEnvelopePreviewConsolidationEntriesResponse = {
|
|
12899
|
+
/**
|
|
12900
|
+
* Operation
|
|
12901
|
+
*
|
|
12902
|
+
* Kebab-case operation name
|
|
12903
|
+
*/
|
|
12904
|
+
operation: string;
|
|
12905
|
+
/**
|
|
12906
|
+
* Operationid
|
|
12907
|
+
*
|
|
12908
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
12909
|
+
*/
|
|
12910
|
+
operationId: string;
|
|
12911
|
+
/**
|
|
12912
|
+
* Status
|
|
12913
|
+
*
|
|
12914
|
+
* Operation lifecycle state
|
|
12915
|
+
*/
|
|
12916
|
+
status: 'completed' | 'pending' | 'failed';
|
|
12917
|
+
/**
|
|
12918
|
+
* Command-specific result payload
|
|
12919
|
+
*/
|
|
12920
|
+
result?: PreviewConsolidationEntriesResponse | null;
|
|
12921
|
+
/**
|
|
12922
|
+
* At
|
|
12923
|
+
*
|
|
12924
|
+
* ISO-8601 UTC timestamp
|
|
12925
|
+
*/
|
|
12926
|
+
at: string;
|
|
12927
|
+
/**
|
|
12928
|
+
* Createdby
|
|
12929
|
+
*
|
|
12930
|
+
* User ID that initiated the operation
|
|
12931
|
+
*/
|
|
12932
|
+
createdBy?: string | null;
|
|
12933
|
+
/**
|
|
12934
|
+
* Idempotentreplay
|
|
12935
|
+
*
|
|
12936
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
12937
|
+
*/
|
|
12938
|
+
idempotentReplay?: boolean;
|
|
12939
|
+
};
|
|
12592
12940
|
/**
|
|
12593
12941
|
* OperationEnvelope[PreviewEventBlockResponse]
|
|
12594
12942
|
*/
|
|
@@ -12679,6 +13027,51 @@ export type OperationEnvelopePromoteObligationsResponse = {
|
|
|
12679
13027
|
*/
|
|
12680
13028
|
idempotentReplay?: boolean;
|
|
12681
13029
|
};
|
|
13030
|
+
/**
|
|
13031
|
+
* OperationEnvelope[ProposeConsolidationEntriesResponse]
|
|
13032
|
+
*/
|
|
13033
|
+
export type OperationEnvelopeProposeConsolidationEntriesResponse = {
|
|
13034
|
+
/**
|
|
13035
|
+
* Operation
|
|
13036
|
+
*
|
|
13037
|
+
* Kebab-case operation name
|
|
13038
|
+
*/
|
|
13039
|
+
operation: string;
|
|
13040
|
+
/**
|
|
13041
|
+
* Operationid
|
|
13042
|
+
*
|
|
13043
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
13044
|
+
*/
|
|
13045
|
+
operationId: string;
|
|
13046
|
+
/**
|
|
13047
|
+
* Status
|
|
13048
|
+
*
|
|
13049
|
+
* Operation lifecycle state
|
|
13050
|
+
*/
|
|
13051
|
+
status: 'completed' | 'pending' | 'failed';
|
|
13052
|
+
/**
|
|
13053
|
+
* Command-specific result payload
|
|
13054
|
+
*/
|
|
13055
|
+
result?: ProposeConsolidationEntriesResponse | null;
|
|
13056
|
+
/**
|
|
13057
|
+
* At
|
|
13058
|
+
*
|
|
13059
|
+
* ISO-8601 UTC timestamp
|
|
13060
|
+
*/
|
|
13061
|
+
at: string;
|
|
13062
|
+
/**
|
|
13063
|
+
* Createdby
|
|
13064
|
+
*
|
|
13065
|
+
* User ID that initiated the operation
|
|
13066
|
+
*/
|
|
13067
|
+
createdBy?: string | null;
|
|
13068
|
+
/**
|
|
13069
|
+
* Idempotentreplay
|
|
13070
|
+
*
|
|
13071
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
13072
|
+
*/
|
|
13073
|
+
idempotentReplay?: boolean;
|
|
13074
|
+
};
|
|
12682
13075
|
/**
|
|
12683
13076
|
* OperationEnvelope[PublishListResponse]
|
|
12684
13077
|
*/
|
|
@@ -14952,6 +15345,92 @@ export type PositionBlock = {
|
|
|
14952
15345
|
*/
|
|
14953
15346
|
security: SecurityLite;
|
|
14954
15347
|
};
|
|
15348
|
+
/**
|
|
15349
|
+
* PreviewConsolidationEntriesRequest
|
|
15350
|
+
*
|
|
15351
|
+
* The month to compute the consolidating entries for.
|
|
15352
|
+
*/
|
|
15353
|
+
export type PreviewConsolidationEntriesRequest = {
|
|
15354
|
+
/**
|
|
15355
|
+
* Period
|
|
15356
|
+
*
|
|
15357
|
+
* The month, as YYYY-MM.
|
|
15358
|
+
*/
|
|
15359
|
+
period: string;
|
|
15360
|
+
};
|
|
15361
|
+
/**
|
|
15362
|
+
* PreviewConsolidationEntriesResponse
|
|
15363
|
+
*
|
|
15364
|
+
* The consolidating entries a month needs, computed from the books.
|
|
15365
|
+
*/
|
|
15366
|
+
export type PreviewConsolidationEntriesResponse = {
|
|
15367
|
+
/**
|
|
15368
|
+
* Period
|
|
15369
|
+
*
|
|
15370
|
+
* The month, as YYYY-MM.
|
|
15371
|
+
*/
|
|
15372
|
+
period: string;
|
|
15373
|
+
/**
|
|
15374
|
+
* Period Start
|
|
15375
|
+
*
|
|
15376
|
+
* The month's first day.
|
|
15377
|
+
*/
|
|
15378
|
+
period_start: string;
|
|
15379
|
+
/**
|
|
15380
|
+
* Period End
|
|
15381
|
+
*
|
|
15382
|
+
* The month's last day.
|
|
15383
|
+
*/
|
|
15384
|
+
period_end: string;
|
|
15385
|
+
/**
|
|
15386
|
+
* Consolidation Entity Id
|
|
15387
|
+
*
|
|
15388
|
+
* The entity the entries post in.
|
|
15389
|
+
*/
|
|
15390
|
+
consolidation_entity_id: string;
|
|
15391
|
+
/**
|
|
15392
|
+
* Proposals
|
|
15393
|
+
*
|
|
15394
|
+
* The entries to post; empty when the month is up to date.
|
|
15395
|
+
*/
|
|
15396
|
+
proposals?: Array<ConsolidationProposal>;
|
|
15397
|
+
/**
|
|
15398
|
+
* Residuals
|
|
15399
|
+
*
|
|
15400
|
+
* Differences withheld from the proposals until explained.
|
|
15401
|
+
*/
|
|
15402
|
+
residuals?: Array<ConsolidationResidual>;
|
|
15403
|
+
/**
|
|
15404
|
+
* Reconciling Items
|
|
15405
|
+
*
|
|
15406
|
+
* Intercompany figures the two sides do not agree on.
|
|
15407
|
+
*/
|
|
15408
|
+
reconciling_items?: Array<ConsolidationReconcilingItem>;
|
|
15409
|
+
/**
|
|
15410
|
+
* Notes
|
|
15411
|
+
*
|
|
15412
|
+
* Anything the engine left out, and why.
|
|
15413
|
+
*/
|
|
15414
|
+
notes?: Array<string>;
|
|
15415
|
+
/**
|
|
15416
|
+
* Up To Date
|
|
15417
|
+
*
|
|
15418
|
+
* True when nothing is proposed, withheld or left out: the consolidation entity already holds what the month needs. A closed month is up to date as posted; read `closed` first.
|
|
15419
|
+
*/
|
|
15420
|
+
up_to_date: boolean;
|
|
15421
|
+
/**
|
|
15422
|
+
* Closed
|
|
15423
|
+
*
|
|
15424
|
+
* True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
|
|
15425
|
+
*/
|
|
15426
|
+
closed?: boolean;
|
|
15427
|
+
/**
|
|
15428
|
+
* Drafted Entry Ids
|
|
15429
|
+
*
|
|
15430
|
+
* The month's drafts propose-consolidation-entries wrote, waiting for the consolidation entity's close to post them.
|
|
15431
|
+
*/
|
|
15432
|
+
drafted_entry_ids?: Array<string>;
|
|
15433
|
+
};
|
|
14955
15434
|
/**
|
|
14956
15435
|
* PreviewEventBlockResponse
|
|
14957
15436
|
*
|
|
@@ -15097,6 +15576,74 @@ export type PromoteObligationsResponse = {
|
|
|
15097
15576
|
[key: string]: string;
|
|
15098
15577
|
}>;
|
|
15099
15578
|
};
|
|
15579
|
+
/**
|
|
15580
|
+
* ProposeConsolidationEntriesRequest
|
|
15581
|
+
*
|
|
15582
|
+
* The month to draft the consolidating entries for.
|
|
15583
|
+
*/
|
|
15584
|
+
export type ProposeConsolidationEntriesRequest = {
|
|
15585
|
+
/**
|
|
15586
|
+
* Period
|
|
15587
|
+
*
|
|
15588
|
+
* The month, as YYYY-MM.
|
|
15589
|
+
*/
|
|
15590
|
+
period: string;
|
|
15591
|
+
};
|
|
15592
|
+
/**
|
|
15593
|
+
* ProposeConsolidationEntriesResponse
|
|
15594
|
+
*
|
|
15595
|
+
* The consolidating entries drafted for a month.
|
|
15596
|
+
*/
|
|
15597
|
+
export type ProposeConsolidationEntriesResponse = {
|
|
15598
|
+
/**
|
|
15599
|
+
* Period
|
|
15600
|
+
*
|
|
15601
|
+
* The month, as YYYY-MM.
|
|
15602
|
+
*/
|
|
15603
|
+
period: string;
|
|
15604
|
+
/**
|
|
15605
|
+
* Consolidation Entity Id
|
|
15606
|
+
*
|
|
15607
|
+
* The entity the drafts are in.
|
|
15608
|
+
*/
|
|
15609
|
+
consolidation_entity_id: string;
|
|
15610
|
+
/**
|
|
15611
|
+
* Closed
|
|
15612
|
+
*
|
|
15613
|
+
* True when the month is closed and nothing was drafted.
|
|
15614
|
+
*/
|
|
15615
|
+
closed?: boolean;
|
|
15616
|
+
/**
|
|
15617
|
+
* Entries
|
|
15618
|
+
*
|
|
15619
|
+
* The drafts written; the consolidation entity's close posts them.
|
|
15620
|
+
*/
|
|
15621
|
+
entries?: Array<JournalEntryResponse>;
|
|
15622
|
+
/**
|
|
15623
|
+
* Replaced
|
|
15624
|
+
*
|
|
15625
|
+
* Earlier drafts of this month's entries, replaced by these.
|
|
15626
|
+
*/
|
|
15627
|
+
replaced?: number;
|
|
15628
|
+
/**
|
|
15629
|
+
* Residuals
|
|
15630
|
+
*
|
|
15631
|
+
* Differences withheld from the drafts until explained.
|
|
15632
|
+
*/
|
|
15633
|
+
residuals?: Array<ConsolidationResidual>;
|
|
15634
|
+
/**
|
|
15635
|
+
* Reconciling Items
|
|
15636
|
+
*
|
|
15637
|
+
* Intercompany figures the two sides do not agree on.
|
|
15638
|
+
*/
|
|
15639
|
+
reconciling_items?: Array<ConsolidationReconcilingItem>;
|
|
15640
|
+
/**
|
|
15641
|
+
* Notes
|
|
15642
|
+
*
|
|
15643
|
+
* Anything the engine left out, and why.
|
|
15644
|
+
*/
|
|
15645
|
+
notes?: Array<string>;
|
|
15646
|
+
};
|
|
15100
15647
|
/**
|
|
15101
15648
|
* PublishListMemberResponse
|
|
15102
15649
|
*
|
|
@@ -16214,6 +16761,37 @@ export type ReconcilingItemRegenerated = {
|
|
|
16214
16761
|
*/
|
|
16215
16762
|
entry_ids?: Array<string>;
|
|
16216
16763
|
};
|
|
16764
|
+
/**
|
|
16765
|
+
* RecordOpeningBalanceRequest
|
|
16766
|
+
*
|
|
16767
|
+
* The balance sheet a ledger starts from.
|
|
16768
|
+
*/
|
|
16769
|
+
export type RecordOpeningBalanceRequest = {
|
|
16770
|
+
/**
|
|
16771
|
+
* Entity Id
|
|
16772
|
+
*
|
|
16773
|
+
* The entity whose books start here; omit for the group parent.
|
|
16774
|
+
*/
|
|
16775
|
+
entity_id?: string | null;
|
|
16776
|
+
/**
|
|
16777
|
+
* Balances
|
|
16778
|
+
*
|
|
16779
|
+
* One balance per balance-sheet account (assets, liabilities, equity). An income or expense account is refused: income before the books begin is already in retained earnings.
|
|
16780
|
+
*/
|
|
16781
|
+
balances: Array<OpeningBalanceInput>;
|
|
16782
|
+
/**
|
|
16783
|
+
* Equity Element Id
|
|
16784
|
+
*
|
|
16785
|
+
* The equity account that takes any difference between debits and credits, usually Opening Balance Equity. Required when the balances do not balance; a non-zero balance left there is a review item.
|
|
16786
|
+
*/
|
|
16787
|
+
equity_element_id?: string | null;
|
|
16788
|
+
/**
|
|
16789
|
+
* Memo
|
|
16790
|
+
*
|
|
16791
|
+
* The entry's memo; defaults to 'Opening balances'.
|
|
16792
|
+
*/
|
|
16793
|
+
memo?: string | null;
|
|
16794
|
+
};
|
|
16217
16795
|
/**
|
|
16218
16796
|
* RecordStatementBalanceRequest
|
|
16219
16797
|
*
|
|
@@ -18140,6 +18718,51 @@ export type ServiceOfferingsResponse = {
|
|
|
18140
18718
|
*/
|
|
18141
18719
|
summary: ServiceOfferingSummary;
|
|
18142
18720
|
};
|
|
18721
|
+
/**
|
|
18722
|
+
* SetAllocationOverrideRequest
|
|
18723
|
+
*
|
|
18724
|
+
* The outside owners' share of a member's result for one month, set by a
|
|
18725
|
+
* person in place of the pro-rata share: a preferred return, a waterfall, a
|
|
18726
|
+
* special allocation.
|
|
18727
|
+
*/
|
|
18728
|
+
export type SetAllocationOverrideRequest = {
|
|
18729
|
+
/**
|
|
18730
|
+
* Entity Id
|
|
18731
|
+
*
|
|
18732
|
+
* The member, consolidated in full.
|
|
18733
|
+
*/
|
|
18734
|
+
entity_id: string;
|
|
18735
|
+
/**
|
|
18736
|
+
* Period
|
|
18737
|
+
*
|
|
18738
|
+
* The month, as YYYY-MM.
|
|
18739
|
+
*/
|
|
18740
|
+
period: string;
|
|
18741
|
+
/**
|
|
18742
|
+
* Amount
|
|
18743
|
+
*
|
|
18744
|
+
* The outside owners' share of the month's result, in cents; negative for a share of a loss.
|
|
18745
|
+
*/
|
|
18746
|
+
amount?: number | null;
|
|
18747
|
+
/**
|
|
18748
|
+
* Percentage
|
|
18749
|
+
*
|
|
18750
|
+
* The outside owners' share as a percentage of the month's result.
|
|
18751
|
+
*/
|
|
18752
|
+
percentage?: number | null;
|
|
18753
|
+
/**
|
|
18754
|
+
* Basis
|
|
18755
|
+
*
|
|
18756
|
+
* Why the share differs from the ownership percentage; required to set one.
|
|
18757
|
+
*/
|
|
18758
|
+
basis?: string | null;
|
|
18759
|
+
/**
|
|
18760
|
+
* Clear
|
|
18761
|
+
*
|
|
18762
|
+
* Remove the month's override, back to the pro-rata share.
|
|
18763
|
+
*/
|
|
18764
|
+
clear?: boolean;
|
|
18765
|
+
};
|
|
18143
18766
|
/**
|
|
18144
18767
|
* SetCloseTargetOperation
|
|
18145
18768
|
*/
|
|
@@ -30873,6 +31496,183 @@ export type SignOffReconciliationResponses = {
|
|
|
30873
31496
|
200: OperationEnvelopeReconciliationSummary;
|
|
30874
31497
|
};
|
|
30875
31498
|
export type SignOffReconciliationResponse = SignOffReconciliationResponses[keyof SignOffReconciliationResponses];
|
|
31499
|
+
export type RecordOpeningBalanceData = {
|
|
31500
|
+
body: RecordOpeningBalanceRequest;
|
|
31501
|
+
headers?: {
|
|
31502
|
+
/**
|
|
31503
|
+
* Idempotency-Key
|
|
31504
|
+
*/
|
|
31505
|
+
'Idempotency-Key'?: string | null;
|
|
31506
|
+
};
|
|
31507
|
+
path: {
|
|
31508
|
+
/**
|
|
31509
|
+
* Graph Id
|
|
31510
|
+
*/
|
|
31511
|
+
graph_id: string;
|
|
31512
|
+
};
|
|
31513
|
+
query?: never;
|
|
31514
|
+
url: '/extensions/roboledger/{graph_id}/operations/record-opening-balance';
|
|
31515
|
+
};
|
|
31516
|
+
export type RecordOpeningBalanceErrors = {
|
|
31517
|
+
/**
|
|
31518
|
+
* Invalid request
|
|
31519
|
+
*/
|
|
31520
|
+
400: ErrorResponse;
|
|
31521
|
+
/**
|
|
31522
|
+
* Authentication required
|
|
31523
|
+
*/
|
|
31524
|
+
401: ErrorResponse;
|
|
31525
|
+
/**
|
|
31526
|
+
* Access denied
|
|
31527
|
+
*/
|
|
31528
|
+
403: ErrorResponse;
|
|
31529
|
+
/**
|
|
31530
|
+
* Resource not found
|
|
31531
|
+
*/
|
|
31532
|
+
404: ErrorResponse;
|
|
31533
|
+
/**
|
|
31534
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31535
|
+
*/
|
|
31536
|
+
409: ErrorResponse;
|
|
31537
|
+
/**
|
|
31538
|
+
* Validation error
|
|
31539
|
+
*/
|
|
31540
|
+
422: ErrorResponse;
|
|
31541
|
+
/**
|
|
31542
|
+
* Rate limit exceeded
|
|
31543
|
+
*/
|
|
31544
|
+
429: ErrorResponse;
|
|
31545
|
+
/**
|
|
31546
|
+
* Internal server error
|
|
31547
|
+
*/
|
|
31548
|
+
500: ErrorResponse;
|
|
31549
|
+
};
|
|
31550
|
+
export type RecordOpeningBalanceError = RecordOpeningBalanceErrors[keyof RecordOpeningBalanceErrors];
|
|
31551
|
+
export type RecordOpeningBalanceResponses = {
|
|
31552
|
+
/**
|
|
31553
|
+
* Successful Response
|
|
31554
|
+
*/
|
|
31555
|
+
200: OperationEnvelopeJournalEntryResponse;
|
|
31556
|
+
};
|
|
31557
|
+
export type RecordOpeningBalanceResponse = RecordOpeningBalanceResponses[keyof RecordOpeningBalanceResponses];
|
|
31558
|
+
export type ProposeConsolidationEntriesData = {
|
|
31559
|
+
body: ProposeConsolidationEntriesRequest;
|
|
31560
|
+
headers?: {
|
|
31561
|
+
/**
|
|
31562
|
+
* Idempotency-Key
|
|
31563
|
+
*/
|
|
31564
|
+
'Idempotency-Key'?: string | null;
|
|
31565
|
+
};
|
|
31566
|
+
path: {
|
|
31567
|
+
/**
|
|
31568
|
+
* Graph Id
|
|
31569
|
+
*/
|
|
31570
|
+
graph_id: string;
|
|
31571
|
+
};
|
|
31572
|
+
query?: never;
|
|
31573
|
+
url: '/extensions/roboledger/{graph_id}/operations/propose-consolidation-entries';
|
|
31574
|
+
};
|
|
31575
|
+
export type ProposeConsolidationEntriesErrors = {
|
|
31576
|
+
/**
|
|
31577
|
+
* Invalid request
|
|
31578
|
+
*/
|
|
31579
|
+
400: ErrorResponse;
|
|
31580
|
+
/**
|
|
31581
|
+
* Authentication required
|
|
31582
|
+
*/
|
|
31583
|
+
401: ErrorResponse;
|
|
31584
|
+
/**
|
|
31585
|
+
* Access denied
|
|
31586
|
+
*/
|
|
31587
|
+
403: ErrorResponse;
|
|
31588
|
+
/**
|
|
31589
|
+
* Resource not found
|
|
31590
|
+
*/
|
|
31591
|
+
404: ErrorResponse;
|
|
31592
|
+
/**
|
|
31593
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31594
|
+
*/
|
|
31595
|
+
409: ErrorResponse;
|
|
31596
|
+
/**
|
|
31597
|
+
* Validation error
|
|
31598
|
+
*/
|
|
31599
|
+
422: ErrorResponse;
|
|
31600
|
+
/**
|
|
31601
|
+
* Rate limit exceeded
|
|
31602
|
+
*/
|
|
31603
|
+
429: ErrorResponse;
|
|
31604
|
+
/**
|
|
31605
|
+
* Internal server error
|
|
31606
|
+
*/
|
|
31607
|
+
500: ErrorResponse;
|
|
31608
|
+
};
|
|
31609
|
+
export type ProposeConsolidationEntriesError = ProposeConsolidationEntriesErrors[keyof ProposeConsolidationEntriesErrors];
|
|
31610
|
+
export type ProposeConsolidationEntriesResponses = {
|
|
31611
|
+
/**
|
|
31612
|
+
* Successful Response
|
|
31613
|
+
*/
|
|
31614
|
+
200: OperationEnvelopeProposeConsolidationEntriesResponse;
|
|
31615
|
+
};
|
|
31616
|
+
export type ProposeConsolidationEntriesResponse2 = ProposeConsolidationEntriesResponses[keyof ProposeConsolidationEntriesResponses];
|
|
31617
|
+
export type SetAllocationOverrideData = {
|
|
31618
|
+
body: SetAllocationOverrideRequest;
|
|
31619
|
+
headers?: {
|
|
31620
|
+
/**
|
|
31621
|
+
* Idempotency-Key
|
|
31622
|
+
*/
|
|
31623
|
+
'Idempotency-Key'?: string | null;
|
|
31624
|
+
};
|
|
31625
|
+
path: {
|
|
31626
|
+
/**
|
|
31627
|
+
* Graph Id
|
|
31628
|
+
*/
|
|
31629
|
+
graph_id: string;
|
|
31630
|
+
};
|
|
31631
|
+
query?: never;
|
|
31632
|
+
url: '/extensions/roboledger/{graph_id}/operations/set-allocation-override';
|
|
31633
|
+
};
|
|
31634
|
+
export type SetAllocationOverrideErrors = {
|
|
31635
|
+
/**
|
|
31636
|
+
* Invalid request
|
|
31637
|
+
*/
|
|
31638
|
+
400: ErrorResponse;
|
|
31639
|
+
/**
|
|
31640
|
+
* Authentication required
|
|
31641
|
+
*/
|
|
31642
|
+
401: ErrorResponse;
|
|
31643
|
+
/**
|
|
31644
|
+
* Access denied
|
|
31645
|
+
*/
|
|
31646
|
+
403: ErrorResponse;
|
|
31647
|
+
/**
|
|
31648
|
+
* Resource not found
|
|
31649
|
+
*/
|
|
31650
|
+
404: ErrorResponse;
|
|
31651
|
+
/**
|
|
31652
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31653
|
+
*/
|
|
31654
|
+
409: ErrorResponse;
|
|
31655
|
+
/**
|
|
31656
|
+
* Validation error
|
|
31657
|
+
*/
|
|
31658
|
+
422: ErrorResponse;
|
|
31659
|
+
/**
|
|
31660
|
+
* Rate limit exceeded
|
|
31661
|
+
*/
|
|
31662
|
+
429: ErrorResponse;
|
|
31663
|
+
/**
|
|
31664
|
+
* Internal server error
|
|
31665
|
+
*/
|
|
31666
|
+
500: ErrorResponse;
|
|
31667
|
+
};
|
|
31668
|
+
export type SetAllocationOverrideError = SetAllocationOverrideErrors[keyof SetAllocationOverrideErrors];
|
|
31669
|
+
export type SetAllocationOverrideResponses = {
|
|
31670
|
+
/**
|
|
31671
|
+
* Successful Response
|
|
31672
|
+
*/
|
|
31673
|
+
200: OperationEnvelopeAllocationOverrideResponse;
|
|
31674
|
+
};
|
|
31675
|
+
export type SetAllocationOverrideResponse = SetAllocationOverrideResponses[keyof SetAllocationOverrideResponses];
|
|
30876
31676
|
export type UpdateJournalEntryData = {
|
|
30877
31677
|
body: UpdateJournalEntryRequest;
|
|
30878
31678
|
headers?: {
|
|
@@ -32761,6 +33561,65 @@ export type ConsolidationWorksheetResponses = {
|
|
|
32761
33561
|
200: OperationEnvelopeConsolidationWorksheetResponse;
|
|
32762
33562
|
};
|
|
32763
33563
|
export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
|
|
33564
|
+
export type PreviewConsolidationEntriesData = {
|
|
33565
|
+
body: PreviewConsolidationEntriesRequest;
|
|
33566
|
+
headers?: {
|
|
33567
|
+
/**
|
|
33568
|
+
* Idempotency-Key
|
|
33569
|
+
*/
|
|
33570
|
+
'Idempotency-Key'?: string | null;
|
|
33571
|
+
};
|
|
33572
|
+
path: {
|
|
33573
|
+
/**
|
|
33574
|
+
* Graph Id
|
|
33575
|
+
*/
|
|
33576
|
+
graph_id: string;
|
|
33577
|
+
};
|
|
33578
|
+
query?: never;
|
|
33579
|
+
url: '/extensions/roboledger/{graph_id}/operations/preview-consolidation-entries';
|
|
33580
|
+
};
|
|
33581
|
+
export type PreviewConsolidationEntriesErrors = {
|
|
33582
|
+
/**
|
|
33583
|
+
* Invalid request
|
|
33584
|
+
*/
|
|
33585
|
+
400: ErrorResponse;
|
|
33586
|
+
/**
|
|
33587
|
+
* Authentication required
|
|
33588
|
+
*/
|
|
33589
|
+
401: ErrorResponse;
|
|
33590
|
+
/**
|
|
33591
|
+
* Access denied
|
|
33592
|
+
*/
|
|
33593
|
+
403: ErrorResponse;
|
|
33594
|
+
/**
|
|
33595
|
+
* Resource not found
|
|
33596
|
+
*/
|
|
33597
|
+
404: ErrorResponse;
|
|
33598
|
+
/**
|
|
33599
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33600
|
+
*/
|
|
33601
|
+
409: ErrorResponse;
|
|
33602
|
+
/**
|
|
33603
|
+
* Validation error
|
|
33604
|
+
*/
|
|
33605
|
+
422: ErrorResponse;
|
|
33606
|
+
/**
|
|
33607
|
+
* Rate limit exceeded
|
|
33608
|
+
*/
|
|
33609
|
+
429: ErrorResponse;
|
|
33610
|
+
/**
|
|
33611
|
+
* Internal server error
|
|
33612
|
+
*/
|
|
33613
|
+
500: ErrorResponse;
|
|
33614
|
+
};
|
|
33615
|
+
export type PreviewConsolidationEntriesError = PreviewConsolidationEntriesErrors[keyof PreviewConsolidationEntriesErrors];
|
|
33616
|
+
export type PreviewConsolidationEntriesResponses = {
|
|
33617
|
+
/**
|
|
33618
|
+
* Successful Response
|
|
33619
|
+
*/
|
|
33620
|
+
200: OperationEnvelopePreviewConsolidationEntriesResponse;
|
|
33621
|
+
};
|
|
33622
|
+
export type PreviewConsolidationEntriesResponse2 = PreviewConsolidationEntriesResponses[keyof PreviewConsolidationEntriesResponses];
|
|
32764
33623
|
export type CreatePortfolioBlockData = {
|
|
32765
33624
|
body: CreatePortfolioBlockRequest;
|
|
32766
33625
|
headers?: {
|