@robosystems/client 2.31.0 → 2.33.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/types.gen.ts CHANGED
@@ -4759,6 +4759,74 @@ export type DatabaseStorageEntry = {
4759
4759
  size_mb?: number | null;
4760
4760
  };
4761
4761
 
4762
+ /**
4763
+ * DeconsolidationResponse
4764
+ *
4765
+ * A member's leaving as recorded: the draft in the consolidation entity
4766
+ * its close posts, dated the first day of the month after the member's
4767
+ * last.
4768
+ */
4769
+ export type DeconsolidationResponse = {
4770
+ /**
4771
+ * Entity Id
4772
+ *
4773
+ * The member that left.
4774
+ */
4775
+ entity_id: string;
4776
+ /**
4777
+ * Entity Name
4778
+ *
4779
+ * The member's name.
4780
+ */
4781
+ entity_name: string;
4782
+ /**
4783
+ * Left On
4784
+ *
4785
+ * The day it left, as the entity records.
4786
+ */
4787
+ left_on: string;
4788
+ /**
4789
+ * Period
4790
+ *
4791
+ * The month the entry is dated in, as YYYY-MM: the first the group reads without the member.
4792
+ */
4793
+ period: string;
4794
+ /**
4795
+ * Consideration
4796
+ *
4797
+ * Cents the parent received.
4798
+ */
4799
+ consideration: number;
4800
+ /**
4801
+ * Derecognized
4802
+ *
4803
+ * What the consolidation entity held for the member beyond the eliminations its leaving reverses on their own, each taken off.
4804
+ */
4805
+ derecognized?: Array<DerecognizedBalance>;
4806
+ /**
4807
+ * Earnings Restored
4808
+ *
4809
+ * 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.
4810
+ */
4811
+ earnings_restored?: number;
4812
+ /**
4813
+ * Gain Loss
4814
+ *
4815
+ * 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).
4816
+ */
4817
+ gain_loss: number;
4818
+ /**
4819
+ * The deconsolidation entry, a draft the close posts.
4820
+ */
4821
+ entry: JournalEntryResponse;
4822
+ /**
4823
+ * Replaced
4824
+ *
4825
+ * True when it replaced an earlier draft of the deconsolidation.
4826
+ */
4827
+ replaced?: boolean;
4828
+ };
4829
+
4762
4830
  /**
4763
4831
  * DeleteDocumentOp
4764
4832
  *
@@ -5144,6 +5212,27 @@ export type DeleteTaxonomyBlockResponse = {
5144
5212
  cascade_applied?: boolean;
5145
5213
  };
5146
5214
 
5215
+ /**
5216
+ * DerecognizedBalance
5217
+ *
5218
+ * A balance the consolidation entity held for a member that left, taken
5219
+ * off by the deconsolidation.
5220
+ */
5221
+ export type DerecognizedBalance = {
5222
+ /**
5223
+ * Concept
5224
+ *
5225
+ * The rs-gaap concept.
5226
+ */
5227
+ concept: string;
5228
+ /**
5229
+ * Amount
5230
+ *
5231
+ * 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).
5232
+ */
5233
+ amount: number;
5234
+ };
5235
+
5147
5236
  /**
5148
5237
  * DescribeFilingRequest
5149
5238
  *
@@ -7226,6 +7315,10 @@ export type FinancialStatementAnalysisResponse = {
7226
7315
  * Fact Count
7227
7316
  */
7228
7317
  fact_count: number;
7318
+ /**
7319
+ * On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
7320
+ */
7321
+ graph_freshness?: GraphFreshness | null;
7229
7322
  };
7230
7323
 
7231
7324
  /**
@@ -7714,6 +7807,41 @@ export type GraphCapacityResponse = {
7714
7807
  tiers: Array<TierCapacity>;
7715
7808
  };
7716
7809
 
7810
+ /**
7811
+ * GraphFreshness
7812
+ *
7813
+ * Whether a ledger's graph is current with its books.
7814
+ *
7815
+ * A ledger's graph is a projection of its database, rebuilt after writes;
7816
+ * until a rebuild finishes, graph-backed reads answer from the previous one.
7817
+ */
7818
+ export type GraphFreshness = {
7819
+ /**
7820
+ * Stale
7821
+ *
7822
+ * True when the books have changed since the graph was last rebuilt, so this answer can be behind them. A rebuild is queued automatically.
7823
+ */
7824
+ stale: boolean;
7825
+ /**
7826
+ * Stale Since
7827
+ *
7828
+ * When the graph first fell behind the books (ISO 8601); null when current.
7829
+ */
7830
+ stale_since?: string | null;
7831
+ /**
7832
+ * Stale Reason
7833
+ *
7834
+ * The latest write that left the graph behind (e.g. 'period_closed').
7835
+ */
7836
+ stale_reason?: string | null;
7837
+ /**
7838
+ * Last Materialized At
7839
+ *
7840
+ * When the graph was last rebuilt (ISO 8601).
7841
+ */
7842
+ last_materialized_at?: string | null;
7843
+ };
7844
+
7717
7845
  /**
7718
7846
  * GraphInfo
7719
7847
  *
@@ -9896,6 +10024,12 @@ export type LedgerEntityResponse = {
9896
10024
  * 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.
9897
10025
  */
9898
10026
  left_on?: string | null;
10027
+ /**
10028
+ * Is Former
10029
+ *
10030
+ * 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.
10031
+ */
10032
+ is_former?: boolean;
9899
10033
  /**
9900
10034
  * Source
9901
10035
  *
@@ -12285,6 +12419,52 @@ export type OperationEnvelopeConsolidationWorksheetResponse = {
12285
12419
  idempotentReplay?: boolean;
12286
12420
  };
12287
12421
 
12422
+ /**
12423
+ * OperationEnvelope[DeconsolidationResponse]
12424
+ */
12425
+ export type OperationEnvelopeDeconsolidationResponse = {
12426
+ /**
12427
+ * Operation
12428
+ *
12429
+ * Kebab-case operation name
12430
+ */
12431
+ operation: string;
12432
+ /**
12433
+ * Operationid
12434
+ *
12435
+ * op_-prefixed ULID for audit and SSE correlation
12436
+ */
12437
+ operationId: string;
12438
+ /**
12439
+ * Status
12440
+ *
12441
+ * Operation lifecycle state
12442
+ */
12443
+ status: 'completed' | 'pending' | 'failed';
12444
+ /**
12445
+ * Command-specific result payload
12446
+ */
12447
+ result?: DeconsolidationResponse | null;
12448
+ /**
12449
+ * At
12450
+ *
12451
+ * ISO-8601 UTC timestamp
12452
+ */
12453
+ at: string;
12454
+ /**
12455
+ * Createdby
12456
+ *
12457
+ * User ID that initiated the operation
12458
+ */
12459
+ createdBy?: string | null;
12460
+ /**
12461
+ * Idempotentreplay
12462
+ *
12463
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
12464
+ */
12465
+ idempotentReplay?: boolean;
12466
+ };
12467
+
12288
12468
  /**
12289
12469
  * OperationEnvelope[DeleteInformationBlockResponse]
12290
12470
  */
@@ -15227,25 +15407,43 @@ export type OwnershipChangeResponse = {
15227
15407
  /**
15228
15408
  * Consideration
15229
15409
  *
15230
- * Cents paid to the outside owners.
15410
+ * Cents paid to the outside owners, or received from them for shares sold.
15231
15411
  */
15232
15412
  consideration: number;
15233
15413
  /**
15234
15414
  * Book Value
15235
15415
  *
15236
- * Cents: the share bought of the member's capital, which the investment elimination moves from the outside owners to the parent.
15416
+ * Cents: the share bought of the member's capital, which the investment elimination moves from the outside owners to the parent; negative for a share sold, moved the other way.
15237
15417
  */
15238
15418
  book_value: number;
15239
15419
  /**
15240
15420
  * Earnings Transferred
15241
15421
  *
15242
- * Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent.
15422
+ * Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent; negative for a share sold.
15243
15423
  */
15244
15424
  earnings_transferred: number;
15425
+ /**
15426
+ * Premium Transferred
15427
+ *
15428
+ * 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; negative for a share sold.
15429
+ */
15430
+ premium_transferred?: number;
15431
+ /**
15432
+ * Carrying Released
15433
+ *
15434
+ * Cents, for a sale: the carrying amount of the shares sold on the parent's books, its cost pro rata, which its sale entry credits against the investment. Zero for a purchase.
15435
+ */
15436
+ carrying_released?: number;
15437
+ /**
15438
+ * Gain Reversed
15439
+ *
15440
+ * Cents, for a sale: the gain (a loss negative) the parent's own books take, the price less the carrying amount released, which the entry reverses — the group has none while control is kept. Zero for a purchase.
15441
+ */
15442
+ gain_reversed?: number;
15245
15443
  /**
15246
15444
  * Equity Adjustment
15247
15445
  *
15248
- * Cents taken from the parent's equity: the price above the carrying amount of what was bought (negative when it paid less).
15446
+ * Cents taken from the parent's equity (negative: added to it): for a purchase, the price above the carrying amount of what was bought; for a sale, the carrying amount given up above the price.
15249
15447
  */
15250
15448
  equity_adjustment: number;
15251
15449
  /**
@@ -17785,6 +17983,35 @@ export type RecordAcquisitionRequest = {
17785
17983
  confirm_bargain_purchase?: boolean;
17786
17984
  };
17787
17985
 
17986
+ /**
17987
+ * RecordDeconsolidationRequest
17988
+ *
17989
+ * A member has left the group (`left_on` set): what the parent received
17990
+ * for its shares, and the basis. The entry derecognizes what the
17991
+ * consolidation entity still holds for the member and takes the gain or
17992
+ * loss on its leaving; the parent's own sale entry stays on its books.
17993
+ */
17994
+ export type RecordDeconsolidationRequest = {
17995
+ /**
17996
+ * Entity Id
17997
+ *
17998
+ * The member that left: its `left_on` is set.
17999
+ */
18000
+ entity_id: string;
18001
+ /**
18002
+ * Consideration
18003
+ *
18004
+ * 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.
18005
+ */
18006
+ consideration: number;
18007
+ /**
18008
+ * Basis
18009
+ *
18010
+ * The sale agreement, the dissolution, or what sets the price.
18011
+ */
18012
+ basis: string;
18013
+ };
18014
+
17788
18015
  /**
17789
18016
  * RecordOpeningBalanceRequest
17790
18017
  *
@@ -17820,9 +18047,9 @@ export type RecordOpeningBalanceRequest = {
17820
18047
  /**
17821
18048
  * RecordOwnershipChangeRequest
17822
18049
  *
17823
- * The parent buys more of a member from its outside owners, staying on the
17824
- * same consolidation method: the share it holds from a month, and what it
17825
- * paid. ASC 810 makes it an equity transaction, never a gain or loss.
18050
+ * The parent buys more of a member from its outside owners, or sells some
18051
+ * of it to them while keeping control: the share it holds from a month, and
18052
+ * the price. ASC 810 makes it an equity transaction, never a gain or loss.
17826
18053
  */
17827
18054
  export type RecordOwnershipChangeRequest = {
17828
18055
  /**
@@ -17840,19 +18067,19 @@ export type RecordOwnershipChangeRequest = {
17840
18067
  /**
17841
18068
  * Ownership Pct
17842
18069
  *
17843
- * The parent's share from `period`, as a percentage: above its share the month before, and 50 or more, so the member stays consolidated in full.
18070
+ * The parent's share from `period`, as a percentage: above its share the month before for a purchase, below it for a sale, and 50 or more either way, so the member stays consolidated in full.
17844
18071
  */
17845
18072
  ownership_pct: number;
17846
18073
  /**
17847
18074
  * Consideration
17848
18075
  *
17849
- * Cents the parent paid the outside owners for the shares. Its line names them, not the member, which is why it is given here.
18076
+ * Cents the parent paid the outside owners for the shares, or received from them for shares sold. Its line names them, not the member, which is why it is given here.
17850
18077
  */
17851
18078
  consideration: number;
17852
18079
  /**
17853
18080
  * Basis
17854
18081
  *
17855
- * The purchase agreement, or what sets the price.
18082
+ * The purchase or sale agreement, or what sets the price.
17856
18083
  */
17857
18084
  basis: string;
17858
18085
  };
@@ -23237,6 +23464,10 @@ export type ViewMetadata = {
23237
23464
  * True when more facts matched than `limit` allowed. The returned facts are the most recent by period; narrow the filters or raise `limit` to see the rest.
23238
23465
  */
23239
23466
  truncated?: boolean;
23467
+ /**
23468
+ * On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
23469
+ */
23470
+ graph_freshness?: GraphFreshness | null;
23240
23471
  };
23241
23472
 
23242
23473
  /**
@@ -34234,6 +34465,70 @@ export type RecordOwnershipChangeResponses = {
34234
34465
 
34235
34466
  export type RecordOwnershipChangeResponse = RecordOwnershipChangeResponses[keyof RecordOwnershipChangeResponses];
34236
34467
 
34468
+ export type RecordDeconsolidationData = {
34469
+ body: RecordDeconsolidationRequest;
34470
+ headers?: {
34471
+ /**
34472
+ * Idempotency-Key
34473
+ */
34474
+ 'Idempotency-Key'?: string | null;
34475
+ };
34476
+ path: {
34477
+ /**
34478
+ * Graph Id
34479
+ */
34480
+ graph_id: string;
34481
+ };
34482
+ query?: never;
34483
+ url: '/extensions/roboledger/{graph_id}/operations/record-deconsolidation';
34484
+ };
34485
+
34486
+ export type RecordDeconsolidationErrors = {
34487
+ /**
34488
+ * Invalid request
34489
+ */
34490
+ 400: ErrorResponse;
34491
+ /**
34492
+ * Authentication required
34493
+ */
34494
+ 401: ErrorResponse;
34495
+ /**
34496
+ * Access denied
34497
+ */
34498
+ 403: ErrorResponse;
34499
+ /**
34500
+ * Resource not found
34501
+ */
34502
+ 404: ErrorResponse;
34503
+ /**
34504
+ * Idempotency-Key conflict — key reused with different body
34505
+ */
34506
+ 409: ErrorResponse;
34507
+ /**
34508
+ * Validation error
34509
+ */
34510
+ 422: ErrorResponse;
34511
+ /**
34512
+ * Rate limit exceeded
34513
+ */
34514
+ 429: ErrorResponse;
34515
+ /**
34516
+ * Internal server error
34517
+ */
34518
+ 500: ErrorResponse;
34519
+ };
34520
+
34521
+ export type RecordDeconsolidationError = RecordDeconsolidationErrors[keyof RecordDeconsolidationErrors];
34522
+
34523
+ export type RecordDeconsolidationResponses = {
34524
+ /**
34525
+ * Successful Response
34526
+ */
34527
+ 200: OperationEnvelopeDeconsolidationResponse;
34528
+ };
34529
+
34530
+ export type RecordDeconsolidationResponse = RecordDeconsolidationResponses[keyof RecordDeconsolidationResponses];
34531
+
34237
34532
  export type UpdateJournalEntryData = {
34238
34533
  body: UpdateJournalEntryRequest;
34239
34534
  headers?: {