@robosystems/client 2.30.0 → 2.32.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 +208 -23
- package/artifacts/LedgerClient.js +123 -26
- package/artifacts/LedgerClient.ts +333 -47
- package/artifacts/graphql/generated/graphql.d.ts +1 -0
- package/artifacts/graphql/generated/graphql.js +14 -0
- package/artifacts/graphql/generated/graphql.ts +15 -0
- package/artifacts/graphql/queries/ledger/elements.d.ts +2 -1
- package/artifacts/graphql/queries/ledger/elements.js +4 -1
- package/artifacts/graphql/queries/ledger/elements.ts +4 -1
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +4 -2
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +18 -2
- package/sdk/sdk.gen.js +37 -3
- package/sdk/sdk.gen.ts +36 -2
- package/sdk/types.gen.d.ts +726 -8
- package/sdk/types.gen.ts +746 -7
- package/sdk.gen.d.ts +18 -2
- package/sdk.gen.js +37 -3
- package/sdk.gen.ts +36 -2
- package/types.gen.d.ts +726 -8
- package/types.gen.ts +746 -7
package/types.gen.d.ts
CHANGED
|
@@ -3941,9 +3941,9 @@ export type CreateScheduleRequest = {
|
|
|
3941
3941
|
/**
|
|
3942
3942
|
* Monthly Amount
|
|
3943
3943
|
*
|
|
3944
|
-
* Monthly amount in cents
|
|
3944
|
+
* Monthly amount in cents. Required for a straight-line schedule; a custom or loan schedule takes its amounts from its curve.
|
|
3945
3945
|
*/
|
|
3946
|
-
monthly_amount
|
|
3946
|
+
monthly_amount?: number;
|
|
3947
3947
|
entry_template: EntryTemplateRequest;
|
|
3948
3948
|
schedule_metadata?: ScheduleMetadataRequest | null;
|
|
3949
3949
|
/**
|
|
@@ -4654,6 +4654,73 @@ export type DatabaseStorageEntry = {
|
|
|
4654
4654
|
*/
|
|
4655
4655
|
size_mb?: number | null;
|
|
4656
4656
|
};
|
|
4657
|
+
/**
|
|
4658
|
+
* DeconsolidationResponse
|
|
4659
|
+
*
|
|
4660
|
+
* A member's leaving as recorded: the draft in the consolidation entity
|
|
4661
|
+
* its close posts, dated the first day of the month after the member's
|
|
4662
|
+
* last.
|
|
4663
|
+
*/
|
|
4664
|
+
export type DeconsolidationResponse = {
|
|
4665
|
+
/**
|
|
4666
|
+
* Entity Id
|
|
4667
|
+
*
|
|
4668
|
+
* The member that left.
|
|
4669
|
+
*/
|
|
4670
|
+
entity_id: string;
|
|
4671
|
+
/**
|
|
4672
|
+
* Entity Name
|
|
4673
|
+
*
|
|
4674
|
+
* The member's name.
|
|
4675
|
+
*/
|
|
4676
|
+
entity_name: string;
|
|
4677
|
+
/**
|
|
4678
|
+
* Left On
|
|
4679
|
+
*
|
|
4680
|
+
* The day it left, as the entity records.
|
|
4681
|
+
*/
|
|
4682
|
+
left_on: string;
|
|
4683
|
+
/**
|
|
4684
|
+
* Period
|
|
4685
|
+
*
|
|
4686
|
+
* The month the entry is dated in, as YYYY-MM: the first the group reads without the member.
|
|
4687
|
+
*/
|
|
4688
|
+
period: string;
|
|
4689
|
+
/**
|
|
4690
|
+
* Consideration
|
|
4691
|
+
*
|
|
4692
|
+
* Cents the parent received.
|
|
4693
|
+
*/
|
|
4694
|
+
consideration: number;
|
|
4695
|
+
/**
|
|
4696
|
+
* Derecognized
|
|
4697
|
+
*
|
|
4698
|
+
* What the consolidation entity held for the member beyond the eliminations its leaving reverses on their own, each taken off.
|
|
4699
|
+
*/
|
|
4700
|
+
derecognized?: Array<DerecognizedBalance>;
|
|
4701
|
+
/**
|
|
4702
|
+
* Earnings Restored
|
|
4703
|
+
*
|
|
4704
|
+
* Cents: the member's results since it joined, credited to the group's equity as they leave with its books; they were the group's income. Zero for an equity-method member, whose books were never summed.
|
|
4705
|
+
*/
|
|
4706
|
+
earnings_restored?: number;
|
|
4707
|
+
/**
|
|
4708
|
+
* Gain Loss
|
|
4709
|
+
*
|
|
4710
|
+
* Cents, a gain positive: the group's adjustment to the parent's own gain or loss on the sale, so the consolidated gain is the consideration less the carrying amount of what left (ASC 810).
|
|
4711
|
+
*/
|
|
4712
|
+
gain_loss: number;
|
|
4713
|
+
/**
|
|
4714
|
+
* The deconsolidation entry, a draft the close posts.
|
|
4715
|
+
*/
|
|
4716
|
+
entry: JournalEntryResponse;
|
|
4717
|
+
/**
|
|
4718
|
+
* Replaced
|
|
4719
|
+
*
|
|
4720
|
+
* True when it replaced an earlier draft of the deconsolidation.
|
|
4721
|
+
*/
|
|
4722
|
+
replaced?: boolean;
|
|
4723
|
+
};
|
|
4657
4724
|
/**
|
|
4658
4725
|
* DeleteDocumentOp
|
|
4659
4726
|
*
|
|
@@ -5021,6 +5088,26 @@ export type DeleteTaxonomyBlockResponse = {
|
|
|
5021
5088
|
*/
|
|
5022
5089
|
cascade_applied?: boolean;
|
|
5023
5090
|
};
|
|
5091
|
+
/**
|
|
5092
|
+
* DerecognizedBalance
|
|
5093
|
+
*
|
|
5094
|
+
* A balance the consolidation entity held for a member that left, taken
|
|
5095
|
+
* off by the deconsolidation.
|
|
5096
|
+
*/
|
|
5097
|
+
export type DerecognizedBalance = {
|
|
5098
|
+
/**
|
|
5099
|
+
* Concept
|
|
5100
|
+
*
|
|
5101
|
+
* The rs-gaap concept.
|
|
5102
|
+
*/
|
|
5103
|
+
concept: string;
|
|
5104
|
+
/**
|
|
5105
|
+
* Amount
|
|
5106
|
+
*
|
|
5107
|
+
* Cents as held: positive a debit (goodwill, a step-up), negative a credit (the outside owners' interest, the price above book of the parent's investment).
|
|
5108
|
+
*/
|
|
5109
|
+
amount: number;
|
|
5110
|
+
};
|
|
5024
5111
|
/**
|
|
5025
5112
|
* DescribeFilingRequest
|
|
5026
5113
|
*
|
|
@@ -6023,7 +6110,7 @@ export type EntryTemplateRequest = {
|
|
|
6023
6110
|
/**
|
|
6024
6111
|
* Credit Element Id
|
|
6025
6112
|
*
|
|
6026
|
-
* CoA element id to credit (e.g. Accumulated Depreciation). A chart-of-accounts element id (see get-unmapped-elements), not a taxonomy qname.
|
|
6113
|
+
* CoA element id to credit (e.g. Accumulated Depreciation). A chart-of-accounts element id (see get-unmapped-elements), not a taxonomy qname. A straight-line or custom schedule posts this one debit/credit pair; a loan schedule posts its `legs`.
|
|
6027
6114
|
*/
|
|
6028
6115
|
credit_element_id: string;
|
|
6029
6116
|
/**
|
|
@@ -6050,6 +6137,12 @@ export type EntryTemplateRequest = {
|
|
|
6050
6137
|
* The management dimension members (department, class, location, project) every entry the schedule drafts carries on both lines, one per axis: a department's depreciation lands in that department.
|
|
6051
6138
|
*/
|
|
6052
6139
|
dimension_ids?: Array<string>;
|
|
6140
|
+
/**
|
|
6141
|
+
* Legs
|
|
6142
|
+
*
|
|
6143
|
+
* The lines of a loan schedule's entry (`method='effective_interest'` only), each taking one column of the amortization table; each period's lines must balance. Accrue interest and pay through the bank: debit Interest Expense and credit Accrued Interest, both `interest`. The schedule settles the payment itself: debit the note `principal`, debit Interest Expense `interest`, credit cash or a due-to `payment`. `debit_element_id` names the interest debit leg and `credit_element_id` one credit leg. Empty for every other method, which posts the debit/credit pair.
|
|
6144
|
+
*/
|
|
6145
|
+
legs?: Array<ScheduleLegRequest>;
|
|
6053
6146
|
};
|
|
6054
6147
|
/**
|
|
6055
6148
|
* ErrorResponse
|
|
@@ -9671,6 +9764,12 @@ export type LedgerEntityResponse = {
|
|
|
9671
9764
|
* The month this entity left the group, as any date in it; null is a member still. The consolidated statements include it through that month and leave it out after. Membership is by month: a period column wider than a month that overlaps the interval is summed whole, so a member's books in this graph should hold only the months it belonged.
|
|
9672
9765
|
*/
|
|
9673
9766
|
left_on?: string | null;
|
|
9767
|
+
/**
|
|
9768
|
+
* Is Former
|
|
9769
|
+
*
|
|
9770
|
+
* True once the month this entity left the group is over: its months in the group are history, readable under it, and it is no longer current. False for a member still in, and through the month it leaves.
|
|
9771
|
+
*/
|
|
9772
|
+
is_former?: boolean;
|
|
9674
9773
|
/**
|
|
9675
9774
|
* Source
|
|
9676
9775
|
*
|
|
@@ -10444,6 +10543,85 @@ export type LiveStatementFactRow = {
|
|
|
10444
10543
|
*/
|
|
10445
10544
|
sources?: Array<Array<StatementRowSource>> | null;
|
|
10446
10545
|
};
|
|
10546
|
+
/**
|
|
10547
|
+
* LoanTermsRequest
|
|
10548
|
+
*
|
|
10549
|
+
* The terms a loan schedule's amortization table is computed from.
|
|
10550
|
+
*/
|
|
10551
|
+
export type LoanTermsRequest = {
|
|
10552
|
+
/**
|
|
10553
|
+
* Principal
|
|
10554
|
+
*
|
|
10555
|
+
* Principal drawn, in cents.
|
|
10556
|
+
*/
|
|
10557
|
+
principal: number;
|
|
10558
|
+
/**
|
|
10559
|
+
* Annual Rate
|
|
10560
|
+
*
|
|
10561
|
+
* Annual interest rate as a fraction: 0.099 for 9.9%.
|
|
10562
|
+
*/
|
|
10563
|
+
annual_rate: number;
|
|
10564
|
+
/**
|
|
10565
|
+
* Start Date
|
|
10566
|
+
*
|
|
10567
|
+
* The day the principal was drawn; interest accrues from it. Falls in the schedule's first month.
|
|
10568
|
+
*/
|
|
10569
|
+
start_date: string;
|
|
10570
|
+
/**
|
|
10571
|
+
* Day Count
|
|
10572
|
+
*
|
|
10573
|
+
* How a period's interest counts days: `30/360` (every whole month is 30 days), `actual/365` or `actual/360` (the days elapsed, over a 365- or 360-day year; actual/360 is the usual bank line of credit).
|
|
10574
|
+
*/
|
|
10575
|
+
day_count?: '30/360' | 'actual/365' | 'actual/360';
|
|
10576
|
+
/**
|
|
10577
|
+
* Payment Frequency
|
|
10578
|
+
*
|
|
10579
|
+
* How often a payment falls due. A payment is applied at the end of the month it falls in.
|
|
10580
|
+
*/
|
|
10581
|
+
payment_frequency?: 'monthly' | 'quarterly' | 'annual' | 'at_maturity';
|
|
10582
|
+
/**
|
|
10583
|
+
* First Payment Date
|
|
10584
|
+
*
|
|
10585
|
+
* The first payment's date. Omit for one frequency after the schedule's first month.
|
|
10586
|
+
*/
|
|
10587
|
+
first_payment_date?: string | null;
|
|
10588
|
+
/**
|
|
10589
|
+
* Payment Amount
|
|
10590
|
+
*
|
|
10591
|
+
* Each scheduled payment in cents, interest included. Omit for the level payment that retires the principal by `maturity_date`, or for the accrued interest when `interest_only`.
|
|
10592
|
+
*/
|
|
10593
|
+
payment_amount?: number | null;
|
|
10594
|
+
/**
|
|
10595
|
+
* Interest Only
|
|
10596
|
+
*
|
|
10597
|
+
* Payments settle interest only; the principal is due at maturity.
|
|
10598
|
+
*/
|
|
10599
|
+
interest_only?: boolean;
|
|
10600
|
+
/**
|
|
10601
|
+
* Maturity Date
|
|
10602
|
+
*
|
|
10603
|
+
* When the remaining principal is due: it is repaid in that month, which is the schedule's last. Omit for a line of credit with no maturity, whose balance carries past the schedule.
|
|
10604
|
+
*/
|
|
10605
|
+
maturity_date?: string | null;
|
|
10606
|
+
/**
|
|
10607
|
+
* Capitalize Interest
|
|
10608
|
+
*
|
|
10609
|
+
* Interest is added to the note rather than accrued apart (a PIK note): the balance grows by each period's interest, and payments reduce it whole.
|
|
10610
|
+
*/
|
|
10611
|
+
capitalize_interest?: boolean;
|
|
10612
|
+
/**
|
|
10613
|
+
* Note Element Id
|
|
10614
|
+
*
|
|
10615
|
+
* The liability account the principal is carried in. The schedule states its balance each period, which the schedule reconciliation compares with the ledger.
|
|
10616
|
+
*/
|
|
10617
|
+
note_element_id: string;
|
|
10618
|
+
/**
|
|
10619
|
+
* Current Portion Element Id
|
|
10620
|
+
*
|
|
10621
|
+
* A current-liability account for the principal due within twelve months. When set, each period's entry also reclasses between it and `note_element_id` so it holds the next twelve months' principal.
|
|
10622
|
+
*/
|
|
10623
|
+
current_portion_element_id?: string | null;
|
|
10624
|
+
};
|
|
10447
10625
|
/**
|
|
10448
10626
|
* LoginRequest
|
|
10449
10627
|
*
|
|
@@ -11927,6 +12105,51 @@ export type OperationEnvelopeConsolidationWorksheetResponse = {
|
|
|
11927
12105
|
*/
|
|
11928
12106
|
idempotentReplay?: boolean;
|
|
11929
12107
|
};
|
|
12108
|
+
/**
|
|
12109
|
+
* OperationEnvelope[DeconsolidationResponse]
|
|
12110
|
+
*/
|
|
12111
|
+
export type OperationEnvelopeDeconsolidationResponse = {
|
|
12112
|
+
/**
|
|
12113
|
+
* Operation
|
|
12114
|
+
*
|
|
12115
|
+
* Kebab-case operation name
|
|
12116
|
+
*/
|
|
12117
|
+
operation: string;
|
|
12118
|
+
/**
|
|
12119
|
+
* Operationid
|
|
12120
|
+
*
|
|
12121
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
12122
|
+
*/
|
|
12123
|
+
operationId: string;
|
|
12124
|
+
/**
|
|
12125
|
+
* Status
|
|
12126
|
+
*
|
|
12127
|
+
* Operation lifecycle state
|
|
12128
|
+
*/
|
|
12129
|
+
status: 'completed' | 'pending' | 'failed';
|
|
12130
|
+
/**
|
|
12131
|
+
* Command-specific result payload
|
|
12132
|
+
*/
|
|
12133
|
+
result?: DeconsolidationResponse | null;
|
|
12134
|
+
/**
|
|
12135
|
+
* At
|
|
12136
|
+
*
|
|
12137
|
+
* ISO-8601 UTC timestamp
|
|
12138
|
+
*/
|
|
12139
|
+
at: string;
|
|
12140
|
+
/**
|
|
12141
|
+
* Createdby
|
|
12142
|
+
*
|
|
12143
|
+
* User ID that initiated the operation
|
|
12144
|
+
*/
|
|
12145
|
+
createdBy?: string | null;
|
|
12146
|
+
/**
|
|
12147
|
+
* Idempotentreplay
|
|
12148
|
+
*
|
|
12149
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
12150
|
+
*/
|
|
12151
|
+
idempotentReplay?: boolean;
|
|
12152
|
+
};
|
|
11930
12153
|
/**
|
|
11931
12154
|
* OperationEnvelope[DeleteInformationBlockResponse]
|
|
11932
12155
|
*/
|
|
@@ -13232,6 +13455,51 @@ export type OperationEnvelopePreviewEventBlockResponse = {
|
|
|
13232
13455
|
*/
|
|
13233
13456
|
idempotentReplay?: boolean;
|
|
13234
13457
|
};
|
|
13458
|
+
/**
|
|
13459
|
+
* OperationEnvelope[PreviewScheduleResponse]
|
|
13460
|
+
*/
|
|
13461
|
+
export type OperationEnvelopePreviewScheduleResponse = {
|
|
13462
|
+
/**
|
|
13463
|
+
* Operation
|
|
13464
|
+
*
|
|
13465
|
+
* Kebab-case operation name
|
|
13466
|
+
*/
|
|
13467
|
+
operation: string;
|
|
13468
|
+
/**
|
|
13469
|
+
* Operationid
|
|
13470
|
+
*
|
|
13471
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
13472
|
+
*/
|
|
13473
|
+
operationId: string;
|
|
13474
|
+
/**
|
|
13475
|
+
* Status
|
|
13476
|
+
*
|
|
13477
|
+
* Operation lifecycle state
|
|
13478
|
+
*/
|
|
13479
|
+
status: 'completed' | 'pending' | 'failed';
|
|
13480
|
+
/**
|
|
13481
|
+
* Command-specific result payload
|
|
13482
|
+
*/
|
|
13483
|
+
result?: PreviewScheduleResponse | null;
|
|
13484
|
+
/**
|
|
13485
|
+
* At
|
|
13486
|
+
*
|
|
13487
|
+
* ISO-8601 UTC timestamp
|
|
13488
|
+
*/
|
|
13489
|
+
at: string;
|
|
13490
|
+
/**
|
|
13491
|
+
* Createdby
|
|
13492
|
+
*
|
|
13493
|
+
* User ID that initiated the operation
|
|
13494
|
+
*/
|
|
13495
|
+
createdBy?: string | null;
|
|
13496
|
+
/**
|
|
13497
|
+
* Idempotentreplay
|
|
13498
|
+
*
|
|
13499
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
13500
|
+
*/
|
|
13501
|
+
idempotentReplay?: boolean;
|
|
13502
|
+
};
|
|
13235
13503
|
/**
|
|
13236
13504
|
* OperationEnvelope[PromoteObligationsResponse]
|
|
13237
13505
|
*/
|
|
@@ -14770,6 +15038,12 @@ export type OwnershipChangeResponse = {
|
|
|
14770
15038
|
* Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent.
|
|
14771
15039
|
*/
|
|
14772
15040
|
earnings_transferred: number;
|
|
15041
|
+
/**
|
|
15042
|
+
* Premium Transferred
|
|
15043
|
+
*
|
|
15044
|
+
* Cents: the share bought of the outside owners' interest beyond their share of book value (from the acquisition at fair value, or its step-ups), moved to the parent.
|
|
15045
|
+
*/
|
|
15046
|
+
premium_transferred?: number;
|
|
14773
15047
|
/**
|
|
14774
15048
|
* Equity Adjustment
|
|
14775
15049
|
*
|
|
@@ -15825,11 +16099,106 @@ export type PreviewReconciliationsRequest = {
|
|
|
15825
16099
|
*/
|
|
15826
16100
|
export type PreviewReconcilingItemRequest = {
|
|
15827
16101
|
/**
|
|
15828
|
-
* Event Id
|
|
15829
|
-
*
|
|
15830
|
-
* Event id (evt_ prefixed) to inspect
|
|
16102
|
+
* Event Id
|
|
16103
|
+
*
|
|
16104
|
+
* Event id (evt_ prefixed) to inspect
|
|
16105
|
+
*/
|
|
16106
|
+
event_id: string;
|
|
16107
|
+
};
|
|
16108
|
+
/**
|
|
16109
|
+
* PreviewScheduleRequest
|
|
16110
|
+
*
|
|
16111
|
+
* A schedule's definition, generated without being kept.
|
|
16112
|
+
*/
|
|
16113
|
+
export type PreviewScheduleRequest = {
|
|
16114
|
+
/**
|
|
16115
|
+
* Name
|
|
16116
|
+
*
|
|
16117
|
+
* Schedule name
|
|
16118
|
+
*/
|
|
16119
|
+
name: string;
|
|
16120
|
+
/**
|
|
16121
|
+
* Entity Id
|
|
16122
|
+
*
|
|
16123
|
+
* The entity whose books the schedule belongs to, by id. Omit for the group parent. Its facts, obligations and closing entries land in that entity's books, against that entity's own accounts.
|
|
16124
|
+
*/
|
|
16125
|
+
entity_id?: string | null;
|
|
16126
|
+
/**
|
|
16127
|
+
* Taxonomy Id
|
|
16128
|
+
*
|
|
16129
|
+
* Taxonomy ID (auto-creates if omitted)
|
|
16130
|
+
*/
|
|
16131
|
+
taxonomy_id?: string | null;
|
|
16132
|
+
/**
|
|
16133
|
+
* Element Ids
|
|
16134
|
+
*
|
|
16135
|
+
* CoA element ids the schedule touches (the `id` from get-unmapped-elements, not taxonomy qnames) — typically the same debit + credit ids used in entry_template.
|
|
16136
|
+
*/
|
|
16137
|
+
element_ids: Array<string>;
|
|
16138
|
+
/**
|
|
16139
|
+
* Period Start
|
|
16140
|
+
*
|
|
16141
|
+
* First period start
|
|
16142
|
+
*/
|
|
16143
|
+
period_start: string;
|
|
16144
|
+
/**
|
|
16145
|
+
* Period End
|
|
16146
|
+
*
|
|
16147
|
+
* Last period end
|
|
16148
|
+
*/
|
|
16149
|
+
period_end: string;
|
|
16150
|
+
/**
|
|
16151
|
+
* Monthly Amount
|
|
16152
|
+
*
|
|
16153
|
+
* Monthly amount in cents. Required for a straight-line schedule; a custom or loan schedule takes its amounts from its curve.
|
|
16154
|
+
*/
|
|
16155
|
+
monthly_amount?: number;
|
|
16156
|
+
entry_template: EntryTemplateRequest;
|
|
16157
|
+
schedule_metadata?: ScheduleMetadataRequest | null;
|
|
16158
|
+
/**
|
|
16159
|
+
* Closed Through
|
|
16160
|
+
*
|
|
16161
|
+
* Watermark for onboarding. Facts with period_end ≤ this date are flagged 'historical' and their schedule_entry_due obligations are emitted 'voided', so the close workflow starts drafting at the first open period. Defaults to the calendar's history end: the last day of its closed_through month (calendar '2026-05' → '2026-05-31'), or the day before its first month when nothing has closed yet. An earlier date is raised to it, since an obligation there could never post; set a later one only to treat more months as already booked.
|
|
16162
|
+
*/
|
|
16163
|
+
closed_through?: string | null;
|
|
16164
|
+
/**
|
|
16165
|
+
* Source Transaction Id
|
|
16166
|
+
*
|
|
16167
|
+
* Free-form reference to the originating GL transaction (e.g. an import ID, ledger entry ID, or external system key). Stored in artifact_mechanics for audit; no FK constraint.
|
|
16168
|
+
*/
|
|
16169
|
+
source_transaction_id?: string | null;
|
|
16170
|
+
/**
|
|
16171
|
+
* Replaces Structure Id
|
|
16172
|
+
*
|
|
16173
|
+
* The schedule this definition would replace, when editing or recreating one: the preview then says what its posted entries mean for the change.
|
|
16174
|
+
*/
|
|
16175
|
+
replaces_structure_id?: string | null;
|
|
16176
|
+
};
|
|
16177
|
+
/**
|
|
16178
|
+
* PreviewScheduleResponse
|
|
16179
|
+
*
|
|
16180
|
+
* A generated schedule nobody kept: its envelope as create would leave
|
|
16181
|
+
* it, period by period.
|
|
16182
|
+
*/
|
|
16183
|
+
export type PreviewScheduleResponse = {
|
|
16184
|
+
/**
|
|
16185
|
+
* The schedule's Information Block envelope as create would leave it. Its ids are provisional: nothing was written.
|
|
16186
|
+
*/
|
|
16187
|
+
envelope: InformationBlockEnvelope;
|
|
16188
|
+
/**
|
|
16189
|
+
* Roll Forward
|
|
16190
|
+
*/
|
|
16191
|
+
roll_forward?: Array<ScheduleRollForwardRow>;
|
|
16192
|
+
/**
|
|
16193
|
+
* Warnings
|
|
16194
|
+
*
|
|
16195
|
+
* Things create would go ahead with that deserve a look: an active schedule already posting to the same accounts over the same months.
|
|
16196
|
+
*/
|
|
16197
|
+
warnings?: Array<string>;
|
|
16198
|
+
/**
|
|
16199
|
+
* With `replaces_structure_id`: the schedule being replaced.
|
|
15831
16200
|
*/
|
|
15832
|
-
|
|
16201
|
+
replaces?: ScheduleReplacementSummary | null;
|
|
15833
16202
|
};
|
|
15834
16203
|
/**
|
|
15835
16204
|
* PromoteObligationsRequest
|
|
@@ -16255,6 +16624,11 @@ export type ReadTextResponse = {
|
|
|
16255
16624
|
* month, are history), so a rebuild re-scopes the schedule to today's
|
|
16256
16625
|
* close state. Use this to pick up a fixed generator (e.g. the
|
|
16257
16626
|
* roll-forward direction fix) without orphaning obligations.
|
|
16627
|
+
*
|
|
16628
|
+
* It is also how an edit is saved while nothing has posted: the fields below
|
|
16629
|
+
* replace the stored definition before it regenerates, as the schedule's
|
|
16630
|
+
* envelope reads them back (`artifact.mechanics`). Omitted fields keep their
|
|
16631
|
+
* stored values, inside `schedule_metadata` too.
|
|
16258
16632
|
*/
|
|
16259
16633
|
export type RebuildScheduleRequest = {
|
|
16260
16634
|
/**
|
|
@@ -16263,6 +16637,32 @@ export type RebuildScheduleRequest = {
|
|
|
16263
16637
|
* The schedule structure to regenerate in place.
|
|
16264
16638
|
*/
|
|
16265
16639
|
structure_id: string;
|
|
16640
|
+
/**
|
|
16641
|
+
* Period Start
|
|
16642
|
+
*
|
|
16643
|
+
* A new first period start.
|
|
16644
|
+
*/
|
|
16645
|
+
period_start?: string | null;
|
|
16646
|
+
/**
|
|
16647
|
+
* Period End
|
|
16648
|
+
*
|
|
16649
|
+
* A new last period end.
|
|
16650
|
+
*/
|
|
16651
|
+
period_end?: string | null;
|
|
16652
|
+
/**
|
|
16653
|
+
* Monthly Amount
|
|
16654
|
+
*
|
|
16655
|
+
* A new straight-line monthly amount, in cents.
|
|
16656
|
+
*/
|
|
16657
|
+
monthly_amount?: number | null;
|
|
16658
|
+
/**
|
|
16659
|
+
* A new entry template, replacing the stored one whole.
|
|
16660
|
+
*/
|
|
16661
|
+
entry_template?: EntryTemplateRequest | null;
|
|
16662
|
+
/**
|
|
16663
|
+
* The schedule_metadata fields to change.
|
|
16664
|
+
*/
|
|
16665
|
+
schedule_metadata?: ScheduleMetadataRequest | null;
|
|
16266
16666
|
};
|
|
16267
16667
|
/**
|
|
16268
16668
|
* ReconciliationComponent
|
|
@@ -17129,6 +17529,34 @@ export type RecordAcquisitionRequest = {
|
|
|
17129
17529
|
*/
|
|
17130
17530
|
confirm_bargain_purchase?: boolean;
|
|
17131
17531
|
};
|
|
17532
|
+
/**
|
|
17533
|
+
* RecordDeconsolidationRequest
|
|
17534
|
+
*
|
|
17535
|
+
* A member has left the group (`left_on` set): what the parent received
|
|
17536
|
+
* for its shares, and the basis. The entry derecognizes what the
|
|
17537
|
+
* consolidation entity still holds for the member and takes the gain or
|
|
17538
|
+
* loss on its leaving; the parent's own sale entry stays on its books.
|
|
17539
|
+
*/
|
|
17540
|
+
export type RecordDeconsolidationRequest = {
|
|
17541
|
+
/**
|
|
17542
|
+
* Entity Id
|
|
17543
|
+
*
|
|
17544
|
+
* The member that left: its `left_on` is set.
|
|
17545
|
+
*/
|
|
17546
|
+
entity_id: string;
|
|
17547
|
+
/**
|
|
17548
|
+
* Consideration
|
|
17549
|
+
*
|
|
17550
|
+
* Cents the parent received for its shares; 0 for a dissolution or an abandonment. Recorded with the entry for the record: the parent's own books hold the sale, cash against its investment and its own gain or loss, which this entry adjusts to the group's.
|
|
17551
|
+
*/
|
|
17552
|
+
consideration: number;
|
|
17553
|
+
/**
|
|
17554
|
+
* Basis
|
|
17555
|
+
*
|
|
17556
|
+
* The sale agreement, the dissolution, or what sets the price.
|
|
17557
|
+
*/
|
|
17558
|
+
basis: string;
|
|
17559
|
+
};
|
|
17132
17560
|
/**
|
|
17133
17561
|
* RecordOpeningBalanceRequest
|
|
17134
17562
|
*
|
|
@@ -18274,6 +18702,37 @@ export type ScheduleCreatedResponse = {
|
|
|
18274
18702
|
* Pending Event Count
|
|
18275
18703
|
*/
|
|
18276
18704
|
pending_event_count?: number;
|
|
18705
|
+
/**
|
|
18706
|
+
* Warnings
|
|
18707
|
+
*
|
|
18708
|
+
* What the write went ahead with that deserves a look: another active schedule posting to the same accounts over the same months.
|
|
18709
|
+
*/
|
|
18710
|
+
warnings?: Array<string>;
|
|
18711
|
+
};
|
|
18712
|
+
/**
|
|
18713
|
+
* ScheduleLegRequest
|
|
18714
|
+
*
|
|
18715
|
+
* One line of the entry a loan schedule drafts each period.
|
|
18716
|
+
*/
|
|
18717
|
+
export type ScheduleLegRequest = {
|
|
18718
|
+
/**
|
|
18719
|
+
* Element Id
|
|
18720
|
+
*
|
|
18721
|
+
* CoA element id the line posts to.
|
|
18722
|
+
*/
|
|
18723
|
+
element_id: string;
|
|
18724
|
+
/**
|
|
18725
|
+
* Side
|
|
18726
|
+
*
|
|
18727
|
+
* The line's side.
|
|
18728
|
+
*/
|
|
18729
|
+
side: 'debit' | 'credit';
|
|
18730
|
+
/**
|
|
18731
|
+
* Amount Source
|
|
18732
|
+
*
|
|
18733
|
+
* The amortization-table column the line takes each period: `interest` (accrued in the period), `interest_paid` (accrued interest settled by the period's payment), `principal` (principal repaid), `payment` (interest_paid + principal).
|
|
18734
|
+
*/
|
|
18735
|
+
amount_source: 'interest' | 'interest_paid' | 'principal' | 'payment';
|
|
18277
18736
|
};
|
|
18278
18737
|
/**
|
|
18279
18738
|
* ScheduleMechanics
|
|
@@ -18304,6 +18763,42 @@ export type ScheduleMechanics = {
|
|
|
18304
18763
|
* Number of in-scope periods that have at least one closing entry posted. Runtime state derived at envelope-build time from the Entry table.
|
|
18305
18764
|
*/
|
|
18306
18765
|
periods_with_entries?: number;
|
|
18766
|
+
/**
|
|
18767
|
+
* Period Start
|
|
18768
|
+
*
|
|
18769
|
+
* The schedule's first period start, as defined.
|
|
18770
|
+
*/
|
|
18771
|
+
period_start?: string | null;
|
|
18772
|
+
/**
|
|
18773
|
+
* Period End
|
|
18774
|
+
*
|
|
18775
|
+
* The schedule's last period end, as defined. An early end is `end_date`; rebuild-schedule regenerates to this and ends at it again.
|
|
18776
|
+
*/
|
|
18777
|
+
period_end?: string | null;
|
|
18778
|
+
/**
|
|
18779
|
+
* Monthly Amount
|
|
18780
|
+
*
|
|
18781
|
+
* The straight-line monthly amount in cents. With `period_start`, `period_end`, `entry_template` and `schedule_metadata` this is the whole definition: rebuild-schedule takes the same fields back.
|
|
18782
|
+
*/
|
|
18783
|
+
monthly_amount?: number | null;
|
|
18784
|
+
/**
|
|
18785
|
+
* End Date
|
|
18786
|
+
*
|
|
18787
|
+
* Where terminate-schedule ended it, when it did.
|
|
18788
|
+
*/
|
|
18789
|
+
end_date?: string | null;
|
|
18790
|
+
/**
|
|
18791
|
+
* Posted Periods
|
|
18792
|
+
*
|
|
18793
|
+
* The months (YYYY-MM) holding a posted or shadowed closing entry of the schedule, which no edit may rewrite.
|
|
18794
|
+
*/
|
|
18795
|
+
posted_periods?: Array<string>;
|
|
18796
|
+
/**
|
|
18797
|
+
* Edit Warning
|
|
18798
|
+
*
|
|
18799
|
+
* Set once an entry has posted: what deleting, rebuilding or recreating the schedule would do to that history, and the path an edit takes instead.
|
|
18800
|
+
*/
|
|
18801
|
+
edit_warning?: string | null;
|
|
18307
18802
|
};
|
|
18308
18803
|
/**
|
|
18309
18804
|
* ScheduleMetadataRequest
|
|
@@ -18312,9 +18807,13 @@ export type ScheduleMetadataRequest = {
|
|
|
18312
18807
|
/**
|
|
18313
18808
|
* Method
|
|
18314
18809
|
*
|
|
18315
|
-
* Calculation method. 'straight_line' (default) distributes `monthly_amount` evenly across periods with the final period absorbing rounding. 'custom' requires `periodic_amounts` — the generator uses those values verbatim instead of computing. Other strings are labels only; fact values still come from `monthly_amount` or `periodic_amounts`.
|
|
18810
|
+
* Calculation method. 'straight_line' (default) distributes `monthly_amount` evenly across periods with the final period absorbing rounding. 'custom' requires `periodic_amounts` — the generator uses those values verbatim instead of computing. 'effective_interest' requires `loan_terms` and the template's `legs`: the generator computes the amortization table (opening balance, interest, payment, principal, closing balance) and drafts the legs from it. Other strings are labels only; fact values still come from `monthly_amount` or `periodic_amounts`.
|
|
18316
18811
|
*/
|
|
18317
18812
|
method?: string;
|
|
18813
|
+
/**
|
|
18814
|
+
* The loan's terms, for `method='effective_interest'`.
|
|
18815
|
+
*/
|
|
18816
|
+
loan_terms?: LoanTermsRequest | null;
|
|
18318
18817
|
/**
|
|
18319
18818
|
* Original Amount
|
|
18320
18819
|
*
|
|
@@ -18352,6 +18851,107 @@ export type ScheduleMetadataRequest = {
|
|
|
18352
18851
|
*/
|
|
18353
18852
|
periodic_amounts?: Array<number> | null;
|
|
18354
18853
|
};
|
|
18854
|
+
/**
|
|
18855
|
+
* ScheduleReplacementSummary
|
|
18856
|
+
*
|
|
18857
|
+
* What an existing schedule's entries mean for replacing it.
|
|
18858
|
+
*/
|
|
18859
|
+
export type ScheduleReplacementSummary = {
|
|
18860
|
+
/**
|
|
18861
|
+
* Structure Id
|
|
18862
|
+
*/
|
|
18863
|
+
structure_id: string;
|
|
18864
|
+
/**
|
|
18865
|
+
* Name
|
|
18866
|
+
*/
|
|
18867
|
+
name: string;
|
|
18868
|
+
/**
|
|
18869
|
+
* Posted Entry Count
|
|
18870
|
+
*
|
|
18871
|
+
* Its posted or shadowed closing entries.
|
|
18872
|
+
*/
|
|
18873
|
+
posted_entry_count: number;
|
|
18874
|
+
/**
|
|
18875
|
+
* Posted Periods
|
|
18876
|
+
*
|
|
18877
|
+
* The months those entries are in (YYYY-MM).
|
|
18878
|
+
*/
|
|
18879
|
+
posted_periods?: Array<string>;
|
|
18880
|
+
/**
|
|
18881
|
+
* Draft Entry Count
|
|
18882
|
+
*/
|
|
18883
|
+
draft_entry_count?: number;
|
|
18884
|
+
/**
|
|
18885
|
+
* Path
|
|
18886
|
+
*
|
|
18887
|
+
* `rebuild` when nothing has posted: rebuild-schedule with the new definition replaces it in place. `terminate_and_succeed` once an entry has: terminate it after its last posted month and create the successor from the month after.
|
|
18888
|
+
*/
|
|
18889
|
+
path: 'rebuild' | 'terminate_and_succeed';
|
|
18890
|
+
};
|
|
18891
|
+
/**
|
|
18892
|
+
* ScheduleRollForwardRow
|
|
18893
|
+
*
|
|
18894
|
+
* One period of a previewed schedule: the balance it carries, and what
|
|
18895
|
+
* moves it.
|
|
18896
|
+
*/
|
|
18897
|
+
export type ScheduleRollForwardRow = {
|
|
18898
|
+
/**
|
|
18899
|
+
* Period Start
|
|
18900
|
+
*/
|
|
18901
|
+
period_start: string;
|
|
18902
|
+
/**
|
|
18903
|
+
* Period End
|
|
18904
|
+
*/
|
|
18905
|
+
period_end: string;
|
|
18906
|
+
/**
|
|
18907
|
+
* Opening
|
|
18908
|
+
*
|
|
18909
|
+
* The carried balance at the period's start.
|
|
18910
|
+
*/
|
|
18911
|
+
opening: number;
|
|
18912
|
+
/**
|
|
18913
|
+
* Amount
|
|
18914
|
+
*
|
|
18915
|
+
* What the period recognizes: the entry's debit amount.
|
|
18916
|
+
*/
|
|
18917
|
+
amount: number;
|
|
18918
|
+
/**
|
|
18919
|
+
* Closing
|
|
18920
|
+
*
|
|
18921
|
+
* The carried balance at the period's end.
|
|
18922
|
+
*/
|
|
18923
|
+
closing: number;
|
|
18924
|
+
/**
|
|
18925
|
+
* Scope
|
|
18926
|
+
*
|
|
18927
|
+
* `historical` for a month already in the books' history, which the schedule records but never drafts; `in_scope` for one a close drafts.
|
|
18928
|
+
*/
|
|
18929
|
+
scope: 'historical' | 'in_scope';
|
|
18930
|
+
/**
|
|
18931
|
+
* Interest
|
|
18932
|
+
*
|
|
18933
|
+
* Loan schedules: interest accrued.
|
|
18934
|
+
*/
|
|
18935
|
+
interest?: number | null;
|
|
18936
|
+
/**
|
|
18937
|
+
* Payment
|
|
18938
|
+
*
|
|
18939
|
+
* Loan schedules: the payment.
|
|
18940
|
+
*/
|
|
18941
|
+
payment?: number | null;
|
|
18942
|
+
/**
|
|
18943
|
+
* Principal
|
|
18944
|
+
*
|
|
18945
|
+
* Loan schedules: principal repaid.
|
|
18946
|
+
*/
|
|
18947
|
+
principal?: number | null;
|
|
18948
|
+
/**
|
|
18949
|
+
* Current Portion
|
|
18950
|
+
*
|
|
18951
|
+
* Loan schedules with a current-portion account: the principal due in the next twelve months.
|
|
18952
|
+
*/
|
|
18953
|
+
current_portion?: number | null;
|
|
18954
|
+
};
|
|
18355
18955
|
/**
|
|
18356
18956
|
* SchemaExportResponse
|
|
18357
18957
|
*
|
|
@@ -32326,6 +32926,65 @@ export type RecordOwnershipChangeResponses = {
|
|
|
32326
32926
|
200: OperationEnvelopeOwnershipChangeResponse;
|
|
32327
32927
|
};
|
|
32328
32928
|
export type RecordOwnershipChangeResponse = RecordOwnershipChangeResponses[keyof RecordOwnershipChangeResponses];
|
|
32929
|
+
export type RecordDeconsolidationData = {
|
|
32930
|
+
body: RecordDeconsolidationRequest;
|
|
32931
|
+
headers?: {
|
|
32932
|
+
/**
|
|
32933
|
+
* Idempotency-Key
|
|
32934
|
+
*/
|
|
32935
|
+
'Idempotency-Key'?: string | null;
|
|
32936
|
+
};
|
|
32937
|
+
path: {
|
|
32938
|
+
/**
|
|
32939
|
+
* Graph Id
|
|
32940
|
+
*/
|
|
32941
|
+
graph_id: string;
|
|
32942
|
+
};
|
|
32943
|
+
query?: never;
|
|
32944
|
+
url: '/extensions/roboledger/{graph_id}/operations/record-deconsolidation';
|
|
32945
|
+
};
|
|
32946
|
+
export type RecordDeconsolidationErrors = {
|
|
32947
|
+
/**
|
|
32948
|
+
* Invalid request
|
|
32949
|
+
*/
|
|
32950
|
+
400: ErrorResponse;
|
|
32951
|
+
/**
|
|
32952
|
+
* Authentication required
|
|
32953
|
+
*/
|
|
32954
|
+
401: ErrorResponse;
|
|
32955
|
+
/**
|
|
32956
|
+
* Access denied
|
|
32957
|
+
*/
|
|
32958
|
+
403: ErrorResponse;
|
|
32959
|
+
/**
|
|
32960
|
+
* Resource not found
|
|
32961
|
+
*/
|
|
32962
|
+
404: ErrorResponse;
|
|
32963
|
+
/**
|
|
32964
|
+
* Idempotency-Key conflict — key reused with different body
|
|
32965
|
+
*/
|
|
32966
|
+
409: ErrorResponse;
|
|
32967
|
+
/**
|
|
32968
|
+
* Validation error
|
|
32969
|
+
*/
|
|
32970
|
+
422: ErrorResponse;
|
|
32971
|
+
/**
|
|
32972
|
+
* Rate limit exceeded
|
|
32973
|
+
*/
|
|
32974
|
+
429: ErrorResponse;
|
|
32975
|
+
/**
|
|
32976
|
+
* Internal server error
|
|
32977
|
+
*/
|
|
32978
|
+
500: ErrorResponse;
|
|
32979
|
+
};
|
|
32980
|
+
export type RecordDeconsolidationError = RecordDeconsolidationErrors[keyof RecordDeconsolidationErrors];
|
|
32981
|
+
export type RecordDeconsolidationResponses = {
|
|
32982
|
+
/**
|
|
32983
|
+
* Successful Response
|
|
32984
|
+
*/
|
|
32985
|
+
200: OperationEnvelopeDeconsolidationResponse;
|
|
32986
|
+
};
|
|
32987
|
+
export type RecordDeconsolidationResponse = RecordDeconsolidationResponses[keyof RecordDeconsolidationResponses];
|
|
32329
32988
|
export type UpdateJournalEntryData = {
|
|
32330
32989
|
body: UpdateJournalEntryRequest;
|
|
32331
32990
|
headers?: {
|
|
@@ -32739,6 +33398,65 @@ export type PromoteObligationsResponses = {
|
|
|
32739
33398
|
200: OperationEnvelopePromoteObligationsResponse;
|
|
32740
33399
|
};
|
|
32741
33400
|
export type PromoteObligationsResponse2 = PromoteObligationsResponses[keyof PromoteObligationsResponses];
|
|
33401
|
+
export type PreviewScheduleData = {
|
|
33402
|
+
body: PreviewScheduleRequest;
|
|
33403
|
+
headers?: {
|
|
33404
|
+
/**
|
|
33405
|
+
* Idempotency-Key
|
|
33406
|
+
*/
|
|
33407
|
+
'Idempotency-Key'?: string | null;
|
|
33408
|
+
};
|
|
33409
|
+
path: {
|
|
33410
|
+
/**
|
|
33411
|
+
* Graph Id
|
|
33412
|
+
*/
|
|
33413
|
+
graph_id: string;
|
|
33414
|
+
};
|
|
33415
|
+
query?: never;
|
|
33416
|
+
url: '/extensions/roboledger/{graph_id}/operations/preview-schedule';
|
|
33417
|
+
};
|
|
33418
|
+
export type PreviewScheduleErrors = {
|
|
33419
|
+
/**
|
|
33420
|
+
* Invalid request
|
|
33421
|
+
*/
|
|
33422
|
+
400: ErrorResponse;
|
|
33423
|
+
/**
|
|
33424
|
+
* Authentication required
|
|
33425
|
+
*/
|
|
33426
|
+
401: ErrorResponse;
|
|
33427
|
+
/**
|
|
33428
|
+
* Access denied
|
|
33429
|
+
*/
|
|
33430
|
+
403: ErrorResponse;
|
|
33431
|
+
/**
|
|
33432
|
+
* Resource not found
|
|
33433
|
+
*/
|
|
33434
|
+
404: ErrorResponse;
|
|
33435
|
+
/**
|
|
33436
|
+
* Idempotency-Key conflict — key reused with different body
|
|
33437
|
+
*/
|
|
33438
|
+
409: ErrorResponse;
|
|
33439
|
+
/**
|
|
33440
|
+
* Validation error
|
|
33441
|
+
*/
|
|
33442
|
+
422: ErrorResponse;
|
|
33443
|
+
/**
|
|
33444
|
+
* Rate limit exceeded
|
|
33445
|
+
*/
|
|
33446
|
+
429: ErrorResponse;
|
|
33447
|
+
/**
|
|
33448
|
+
* Internal server error
|
|
33449
|
+
*/
|
|
33450
|
+
500: ErrorResponse;
|
|
33451
|
+
};
|
|
33452
|
+
export type PreviewScheduleError = PreviewScheduleErrors[keyof PreviewScheduleErrors];
|
|
33453
|
+
export type PreviewScheduleResponses = {
|
|
33454
|
+
/**
|
|
33455
|
+
* Successful Response
|
|
33456
|
+
*/
|
|
33457
|
+
200: OperationEnvelopePreviewScheduleResponse;
|
|
33458
|
+
};
|
|
33459
|
+
export type PreviewScheduleResponse2 = PreviewScheduleResponses[keyof PreviewScheduleResponses];
|
|
32742
33460
|
export type RebuildScheduleData = {
|
|
32743
33461
|
body: RebuildScheduleRequest;
|
|
32744
33462
|
headers?: {
|