@robosystems/client 2.32.0 → 2.33.1

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/sdk.gen.js CHANGED
@@ -2487,7 +2487,7 @@ exports.recordAcquisition = recordAcquisition;
2487
2487
  /**
2488
2488
  * Record Ownership Change
2489
2489
  *
2490
- * Record the parent buying more of a member consolidated in full from its outside owners: the share it holds from a month (`ownership_pct`, staying 50 or more) and what it paid them in cents, with the basis. It sets the member's share from that month and writes a draft in the consolidation entity, dated the month's first day, that its close posts: ASC 810 makes it an equity transaction, so the price above the book value of the capital bought goes against the investment, the share bought of the member's results since it joined comes out of the outside owners' interest, and the difference is the parent's equity, with no gain or loss. preview-consolidation-entries then reads the price as part of the parent's investment and the new share from that month. Changes are recorded in order; recording a month again replaces its draft, and a posted one is reversed first. A sale, or a change across consolidation methods, is not supported yet.
2490
+ * Record the parent buying more of a member consolidated in full from its outside owners, or selling some of it to them while keeping control: the share it holds from a month (`ownership_pct`, staying 50 or more) and the price in cents, with the basis. It sets the member's share from that month and writes a draft in the consolidation entity, dated the month's first day, that its close posts: ASC 810 makes it an equity transaction with no gain or loss. Buying, the price above the book value of the capital bought goes against the investment, the share bought of the member's results since it joined comes out of the outside owners' interest, and the difference is the parent's equity. Selling, the parent's own entry takes the proceeds against the carrying amount of the shares sold and books its gain or loss; the draft reverses that gain, releases the parent's cost above book on those shares, credits the outside owners their larger share of the member's results, and takes the difference to the parent's equity. preview-consolidation-entries then reads the price paid, net of what a sale released, as part of the parent's investment, and the new share from that month. Changes are recorded in order; recording a month again replaces its draft, and a posted one is reversed first. A change across consolidation methods is not supported yet.
2491
2491
  *
2492
2492
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2493
2493
  */
package/sdk.gen.ts CHANGED
@@ -2498,7 +2498,7 @@ export const recordAcquisition = <ThrowOnError extends boolean = false>(options:
2498
2498
  /**
2499
2499
  * Record Ownership Change
2500
2500
  *
2501
- * Record the parent buying more of a member consolidated in full from its outside owners: the share it holds from a month (`ownership_pct`, staying 50 or more) and what it paid them in cents, with the basis. It sets the member's share from that month and writes a draft in the consolidation entity, dated the month's first day, that its close posts: ASC 810 makes it an equity transaction, so the price above the book value of the capital bought goes against the investment, the share bought of the member's results since it joined comes out of the outside owners' interest, and the difference is the parent's equity, with no gain or loss. preview-consolidation-entries then reads the price as part of the parent's investment and the new share from that month. Changes are recorded in order; recording a month again replaces its draft, and a posted one is reversed first. A sale, or a change across consolidation methods, is not supported yet.
2501
+ * Record the parent buying more of a member consolidated in full from its outside owners, or selling some of it to them while keeping control: the share it holds from a month (`ownership_pct`, staying 50 or more) and the price in cents, with the basis. It sets the member's share from that month and writes a draft in the consolidation entity, dated the month's first day, that its close posts: ASC 810 makes it an equity transaction with no gain or loss. Buying, the price above the book value of the capital bought goes against the investment, the share bought of the member's results since it joined comes out of the outside owners' interest, and the difference is the parent's equity. Selling, the parent's own entry takes the proceeds against the carrying amount of the shares sold and books its gain or loss; the draft reverses that gain, releases the parent's cost above book on those shares, credits the outside owners their larger share of the member's results, and takes the difference to the parent's equity. preview-consolidation-entries then reads the price paid, net of what a sale released, as part of the parent's investment, and the new share from that month. Changes are recorded in order; recording a month again replaces its draft, and a posted one is reversed first. A change across consolidation methods is not supported yet.
2502
2502
  *
2503
2503
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2504
2504
  */
package/types.gen.d.ts CHANGED
@@ -2069,7 +2069,7 @@ export type ClosePeriodResponse = {
2069
2069
  /**
2070
2070
  * Gate Findings
2071
2071
  *
2072
- * Blocker codes a shadow close recorded instead of enforcing: sync_stale, pending_obligations, stranded_obligations, reconciling_items, unposted_source_events, unreconciled_accounts, held_bank_lines. Empty outside shadow.
2072
+ * Blocker codes a shadow close recorded instead of enforcing: sync_stale, pending_obligations, stranded_obligations, reconciling_items, unposted_source_events, unreconciled_accounts, unmapped_accounts, held_bank_lines. Empty outside shadow.
2073
2073
  */
2074
2074
  gate_findings?: Array<string>;
2075
2075
  /**
@@ -7146,6 +7146,10 @@ export type FinancialStatementAnalysisResponse = {
7146
7146
  * Fact Count
7147
7147
  */
7148
7148
  fact_count: number;
7149
+ /**
7150
+ * On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
7151
+ */
7152
+ graph_freshness?: GraphFreshness | null;
7149
7153
  };
7150
7154
  /**
7151
7155
  * FiscalCalendarResponse
@@ -7200,7 +7204,7 @@ export type FiscalCalendarResponse = {
7200
7204
  /**
7201
7205
  * Blockers
7202
7206
  *
7203
- * 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', 'held_bank_lines'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7207
+ * 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', 'unmapped_accounts', 'held_bank_lines'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7204
7208
  */
7205
7209
  blockers?: Array<string>;
7206
7210
  /**
@@ -7287,6 +7291,18 @@ export type FiscalCalendarResponse = {
7287
7291
  * Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
7288
7292
  */
7289
7293
  unreconciled_account_sample?: Array<string>;
7294
+ /**
7295
+ * Unmapped Account Count
7296
+ *
7297
+ * Accounts in this entity's chart with postings through the period that its mapping does not map to a reporting concept. Their balances are in no statement, so the month cannot be stated until each is mapped: suggest-mapping, then create-mapping-association. No override lifts it.
7298
+ */
7299
+ unmapped_account_count?: number;
7300
+ /**
7301
+ * Unmapped Account Sample
7302
+ *
7303
+ * Code and name of up to 5 of those accounts, so the blocker names what is holding the close.
7304
+ */
7305
+ unmapped_account_sample?: Array<string>;
7290
7306
  /**
7291
7307
  * Group Open Entities
7292
7308
  *
@@ -7625,6 +7641,40 @@ export type GraphCapacityResponse = {
7625
7641
  */
7626
7642
  tiers: Array<TierCapacity>;
7627
7643
  };
7644
+ /**
7645
+ * GraphFreshness
7646
+ *
7647
+ * Whether a ledger's graph is current with its books.
7648
+ *
7649
+ * A ledger's graph is a projection of its database, rebuilt after writes;
7650
+ * until a rebuild finishes, graph-backed reads answer from the previous one.
7651
+ */
7652
+ export type GraphFreshness = {
7653
+ /**
7654
+ * Stale
7655
+ *
7656
+ * True when the books have changed since the graph was last rebuilt, so this answer can be behind them. A rebuild is queued automatically.
7657
+ */
7658
+ stale: boolean;
7659
+ /**
7660
+ * Stale Since
7661
+ *
7662
+ * When the graph first fell behind the books (ISO 8601); null when current.
7663
+ */
7664
+ stale_since?: string | null;
7665
+ /**
7666
+ * Stale Reason
7667
+ *
7668
+ * The latest write that left the graph behind (e.g. 'period_closed').
7669
+ */
7670
+ stale_reason?: string | null;
7671
+ /**
7672
+ * Last Materialized At
7673
+ *
7674
+ * When the graph was last rebuilt (ISO 8601).
7675
+ */
7676
+ last_materialized_at?: string | null;
7677
+ };
7628
7678
  /**
7629
7679
  * GraphInfo
7630
7680
  *
@@ -15023,31 +15073,43 @@ export type OwnershipChangeResponse = {
15023
15073
  /**
15024
15074
  * Consideration
15025
15075
  *
15026
- * Cents paid to the outside owners.
15076
+ * Cents paid to the outside owners, or received from them for shares sold.
15027
15077
  */
15028
15078
  consideration: number;
15029
15079
  /**
15030
15080
  * Book Value
15031
15081
  *
15032
- * Cents: the share bought of the member's capital, which the investment elimination moves from the outside owners to the parent.
15082
+ * 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.
15033
15083
  */
15034
15084
  book_value: number;
15035
15085
  /**
15036
15086
  * Earnings Transferred
15037
15087
  *
15038
- * Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent.
15088
+ * 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.
15039
15089
  */
15040
15090
  earnings_transferred: number;
15041
15091
  /**
15042
15092
  * Premium Transferred
15043
15093
  *
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.
15094
+ * 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.
15045
15095
  */
15046
15096
  premium_transferred?: number;
15097
+ /**
15098
+ * Carrying Released
15099
+ *
15100
+ * 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.
15101
+ */
15102
+ carrying_released?: number;
15103
+ /**
15104
+ * Gain Reversed
15105
+ *
15106
+ * 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.
15107
+ */
15108
+ gain_reversed?: number;
15047
15109
  /**
15048
15110
  * Equity Adjustment
15049
15111
  *
15050
- * Cents taken from the parent's equity: the price above the carrying amount of what was bought (negative when it paid less).
15112
+ * 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.
15051
15113
  */
15052
15114
  equity_adjustment: number;
15053
15115
  /**
@@ -17591,9 +17653,9 @@ export type RecordOpeningBalanceRequest = {
17591
17653
  /**
17592
17654
  * RecordOwnershipChangeRequest
17593
17655
  *
17594
- * The parent buys more of a member from its outside owners, staying on the
17595
- * same consolidation method: the share it holds from a month, and what it
17596
- * paid. ASC 810 makes it an equity transaction, never a gain or loss.
17656
+ * The parent buys more of a member from its outside owners, or sells some
17657
+ * of it to them while keeping control: the share it holds from a month, and
17658
+ * the price. ASC 810 makes it an equity transaction, never a gain or loss.
17597
17659
  */
17598
17660
  export type RecordOwnershipChangeRequest = {
17599
17661
  /**
@@ -17611,19 +17673,19 @@ export type RecordOwnershipChangeRequest = {
17611
17673
  /**
17612
17674
  * Ownership Pct
17613
17675
  *
17614
- * 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.
17676
+ * 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.
17615
17677
  */
17616
17678
  ownership_pct: number;
17617
17679
  /**
17618
17680
  * Consideration
17619
17681
  *
17620
- * Cents the parent paid the outside owners for the shares. Its line names them, not the member, which is why it is given here.
17682
+ * 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.
17621
17683
  */
17622
17684
  consideration: number;
17623
17685
  /**
17624
17686
  * Basis
17625
17687
  *
17626
- * The purchase agreement, or what sets the price.
17688
+ * The purchase or sale agreement, or what sets the price.
17627
17689
  */
17628
17690
  basis: string;
17629
17691
  };
@@ -22872,6 +22934,10 @@ export type ViewMetadata = {
22872
22934
  * 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.
22873
22935
  */
22874
22936
  truncated?: boolean;
22937
+ /**
22938
+ * On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
22939
+ */
22940
+ graph_freshness?: GraphFreshness | null;
22875
22941
  };
22876
22942
  /**
22877
22943
  * ViewProjections
package/types.gen.ts CHANGED
@@ -2123,7 +2123,7 @@ export type ClosePeriodResponse = {
2123
2123
  /**
2124
2124
  * Gate Findings
2125
2125
  *
2126
- * Blocker codes a shadow close recorded instead of enforcing: sync_stale, pending_obligations, stranded_obligations, reconciling_items, unposted_source_events, unreconciled_accounts, held_bank_lines. Empty outside shadow.
2126
+ * Blocker codes a shadow close recorded instead of enforcing: sync_stale, pending_obligations, stranded_obligations, reconciling_items, unposted_source_events, unreconciled_accounts, unmapped_accounts, held_bank_lines. Empty outside shadow.
2127
2127
  */
2128
2128
  gate_findings?: Array<string>;
2129
2129
  /**
@@ -7315,6 +7315,10 @@ export type FinancialStatementAnalysisResponse = {
7315
7315
  * Fact Count
7316
7316
  */
7317
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;
7318
7322
  };
7319
7323
 
7320
7324
  /**
@@ -7370,7 +7374,7 @@ export type FiscalCalendarResponse = {
7370
7374
  /**
7371
7375
  * Blockers
7372
7376
  *
7373
- * 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', 'held_bank_lines'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7377
+ * 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', 'unmapped_accounts', 'held_bank_lines'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7374
7378
  */
7375
7379
  blockers?: Array<string>;
7376
7380
  /**
@@ -7457,6 +7461,18 @@ export type FiscalCalendarResponse = {
7457
7461
  * Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
7458
7462
  */
7459
7463
  unreconciled_account_sample?: Array<string>;
7464
+ /**
7465
+ * Unmapped Account Count
7466
+ *
7467
+ * Accounts in this entity's chart with postings through the period that its mapping does not map to a reporting concept. Their balances are in no statement, so the month cannot be stated until each is mapped: suggest-mapping, then create-mapping-association. No override lifts it.
7468
+ */
7469
+ unmapped_account_count?: number;
7470
+ /**
7471
+ * Unmapped Account Sample
7472
+ *
7473
+ * Code and name of up to 5 of those accounts, so the blocker names what is holding the close.
7474
+ */
7475
+ unmapped_account_sample?: Array<string>;
7460
7476
  /**
7461
7477
  * Group Open Entities
7462
7478
  *
@@ -7803,6 +7819,41 @@ export type GraphCapacityResponse = {
7803
7819
  tiers: Array<TierCapacity>;
7804
7820
  };
7805
7821
 
7822
+ /**
7823
+ * GraphFreshness
7824
+ *
7825
+ * Whether a ledger's graph is current with its books.
7826
+ *
7827
+ * A ledger's graph is a projection of its database, rebuilt after writes;
7828
+ * until a rebuild finishes, graph-backed reads answer from the previous one.
7829
+ */
7830
+ export type GraphFreshness = {
7831
+ /**
7832
+ * Stale
7833
+ *
7834
+ * True when the books have changed since the graph was last rebuilt, so this answer can be behind them. A rebuild is queued automatically.
7835
+ */
7836
+ stale: boolean;
7837
+ /**
7838
+ * Stale Since
7839
+ *
7840
+ * When the graph first fell behind the books (ISO 8601); null when current.
7841
+ */
7842
+ stale_since?: string | null;
7843
+ /**
7844
+ * Stale Reason
7845
+ *
7846
+ * The latest write that left the graph behind (e.g. 'period_closed').
7847
+ */
7848
+ stale_reason?: string | null;
7849
+ /**
7850
+ * Last Materialized At
7851
+ *
7852
+ * When the graph was last rebuilt (ISO 8601).
7853
+ */
7854
+ last_materialized_at?: string | null;
7855
+ };
7856
+
7806
7857
  /**
7807
7858
  * GraphInfo
7808
7859
  *
@@ -15368,31 +15419,43 @@ export type OwnershipChangeResponse = {
15368
15419
  /**
15369
15420
  * Consideration
15370
15421
  *
15371
- * Cents paid to the outside owners.
15422
+ * Cents paid to the outside owners, or received from them for shares sold.
15372
15423
  */
15373
15424
  consideration: number;
15374
15425
  /**
15375
15426
  * Book Value
15376
15427
  *
15377
- * Cents: the share bought of the member's capital, which the investment elimination moves from the outside owners to the parent.
15428
+ * 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.
15378
15429
  */
15379
15430
  book_value: number;
15380
15431
  /**
15381
15432
  * Earnings Transferred
15382
15433
  *
15383
- * Cents: the share bought of the member's results since it joined, moved from the outside owners' interest to the parent.
15434
+ * 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.
15384
15435
  */
15385
15436
  earnings_transferred: number;
15386
15437
  /**
15387
15438
  * Premium Transferred
15388
15439
  *
15389
- * 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.
15440
+ * 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.
15390
15441
  */
15391
15442
  premium_transferred?: number;
15443
+ /**
15444
+ * Carrying Released
15445
+ *
15446
+ * 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.
15447
+ */
15448
+ carrying_released?: number;
15449
+ /**
15450
+ * Gain Reversed
15451
+ *
15452
+ * 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.
15453
+ */
15454
+ gain_reversed?: number;
15392
15455
  /**
15393
15456
  * Equity Adjustment
15394
15457
  *
15395
- * Cents taken from the parent's equity: the price above the carrying amount of what was bought (negative when it paid less).
15458
+ * 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.
15396
15459
  */
15397
15460
  equity_adjustment: number;
15398
15461
  /**
@@ -17996,9 +18059,9 @@ export type RecordOpeningBalanceRequest = {
17996
18059
  /**
17997
18060
  * RecordOwnershipChangeRequest
17998
18061
  *
17999
- * The parent buys more of a member from its outside owners, staying on the
18000
- * same consolidation method: the share it holds from a month, and what it
18001
- * paid. ASC 810 makes it an equity transaction, never a gain or loss.
18062
+ * The parent buys more of a member from its outside owners, or sells some
18063
+ * of it to them while keeping control: the share it holds from a month, and
18064
+ * the price. ASC 810 makes it an equity transaction, never a gain or loss.
18002
18065
  */
18003
18066
  export type RecordOwnershipChangeRequest = {
18004
18067
  /**
@@ -18016,19 +18079,19 @@ export type RecordOwnershipChangeRequest = {
18016
18079
  /**
18017
18080
  * Ownership Pct
18018
18081
  *
18019
- * 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.
18082
+ * 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.
18020
18083
  */
18021
18084
  ownership_pct: number;
18022
18085
  /**
18023
18086
  * Consideration
18024
18087
  *
18025
- * Cents the parent paid the outside owners for the shares. Its line names them, not the member, which is why it is given here.
18088
+ * 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.
18026
18089
  */
18027
18090
  consideration: number;
18028
18091
  /**
18029
18092
  * Basis
18030
18093
  *
18031
- * The purchase agreement, or what sets the price.
18094
+ * The purchase or sale agreement, or what sets the price.
18032
18095
  */
18033
18096
  basis: string;
18034
18097
  };
@@ -23413,6 +23476,10 @@ export type ViewMetadata = {
23413
23476
  * 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.
23414
23477
  */
23415
23478
  truncated?: boolean;
23479
+ /**
23480
+ * On a ledger's graph, whether the graph is current with the books; null on shared repositories, which are not rebuilt from a ledger.
23481
+ */
23482
+ graph_freshness?: GraphFreshness | null;
23416
23483
  };
23417
23484
 
23418
23485
  /**