@robosystems/client 2.16.0 → 2.18.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
@@ -2597,6 +2597,114 @@ export type ConnectionResponse = {
2597
2597
  };
2598
2598
  };
2599
2599
 
2600
+ /**
2601
+ * ConsolidationWorksheetRequest
2602
+ *
2603
+ * Request for consolidation-worksheet (OLTP, entity graphs only).
2604
+ */
2605
+ export type ConsolidationWorksheetRequest = {
2606
+ /**
2607
+ * Statement Type
2608
+ *
2609
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement.
2610
+ */
2611
+ statement_type: string;
2612
+ /**
2613
+ * Period Start
2614
+ *
2615
+ * Explicit window start. Overrides period_type/fiscal_year.
2616
+ */
2617
+ period_start?: string | null;
2618
+ /**
2619
+ * Period End
2620
+ *
2621
+ * Explicit window end. Overrides period_type/fiscal_year.
2622
+ */
2623
+ period_end?: string | null;
2624
+ /**
2625
+ * Period Type
2626
+ *
2627
+ * annual | quarterly | instant (ignored when dates supplied)
2628
+ */
2629
+ period_type?: string | null;
2630
+ /**
2631
+ * Fiscal Year
2632
+ *
2633
+ * Fiscal year for annual window (anchored on FiscalCalendar)
2634
+ */
2635
+ fiscal_year?: number | null;
2636
+ /**
2637
+ * Limit
2638
+ *
2639
+ * Max rows returned. Defaults to the ceiling: the whole statement.
2640
+ */
2641
+ limit?: number;
2642
+ };
2643
+
2644
+ /**
2645
+ * ConsolidationWorksheetResponse
2646
+ *
2647
+ * The group's statement with the entity as the column.
2648
+ */
2649
+ export type ConsolidationWorksheetResponse = {
2650
+ /**
2651
+ * Graph Id
2652
+ *
2653
+ * The graph read.
2654
+ */
2655
+ graph_id: string;
2656
+ /**
2657
+ * Entity Id
2658
+ *
2659
+ * The group parent.
2660
+ */
2661
+ entity_id: string;
2662
+ /**
2663
+ * Statement Type
2664
+ *
2665
+ * The statement rendered.
2666
+ */
2667
+ statement_type: string;
2668
+ /**
2669
+ * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2670
+ */
2671
+ period: PeriodSpec;
2672
+ /**
2673
+ * Columns
2674
+ *
2675
+ * The parent, each member consolidated in full, `combined`, the consolidation entity's adjustments (when the group has one), `consolidated`, then the equity-method and cost members outside the sum. A member outside its membership interval for the period has no column.
2676
+ */
2677
+ columns: Array<WorksheetColumn>;
2678
+ /**
2679
+ * Rows
2680
+ *
2681
+ * The union of every column's lines in the parent's Style order; a line zero in every column is left out.
2682
+ */
2683
+ rows: Array<WorksheetRow>;
2684
+ /**
2685
+ * The guard-rail outcome for the consolidated column, the same checks live-financial-statement runs.
2686
+ */
2687
+ validation?: ValidationCheckResponse | null;
2688
+ /**
2689
+ * Unmapped Entity Ids
2690
+ *
2691
+ * Entities with no CoA mapping yet, so with no column.
2692
+ */
2693
+ unmapped_entity_ids?: Array<string>;
2694
+ /**
2695
+ * Unmapped Count
2696
+ *
2697
+ * Unmapped accounts across the summed columns.
2698
+ */
2699
+ unmapped_count?: number;
2700
+ /**
2701
+ * Truncated
2702
+ *
2703
+ * Whether `limit` cut rows.
2704
+ */
2705
+ truncated?: boolean;
2706
+ };
2707
+
2600
2708
  /**
2601
2709
  * ContentLimits
2602
2710
  *
@@ -10114,6 +10222,12 @@ export type LiveFinancialStatementResponse = {
10114
10222
  * 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.
10115
10223
  */
10116
10224
  periods: Array<PeriodSpec>;
10225
+ /**
10226
+ * Omitted Periods
10227
+ *
10228
+ * 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.
10229
+ */
10230
+ omitted_periods?: Array<PeriodSpec>;
10117
10231
  /**
10118
10232
  * Facts
10119
10233
  */
@@ -10916,6 +11030,34 @@ export type OfferingRepositoryPlan = {
10916
11030
  } | null;
10917
11031
  };
10918
11032
 
11033
+ /**
11034
+ * OpeningBalanceInput
11035
+ *
11036
+ * One account's balance on the day the books begin, in its normal
11037
+ * direction: an asset as a debit, a liability or equity account as a credit
11038
+ * (a contra account the other way).
11039
+ */
11040
+ export type OpeningBalanceInput = {
11041
+ /**
11042
+ * Element Id
11043
+ *
11044
+ * The balance-sheet account, by id.
11045
+ */
11046
+ element_id: string;
11047
+ /**
11048
+ * Debit Amount
11049
+ *
11050
+ * Debit balance in cents.
11051
+ */
11052
+ debit_amount?: number;
11053
+ /**
11054
+ * Credit Amount
11055
+ *
11056
+ * Credit balance in cents.
11057
+ */
11058
+ credit_amount?: number;
11059
+ };
11060
+
10919
11061
  /**
10920
11062
  * OperationCosts
10921
11063
  *
@@ -11575,6 +11717,52 @@ export type OperationEnvelopeComputeMetricsResponse = {
11575
11717
  idempotentReplay?: boolean;
11576
11718
  };
11577
11719
 
11720
+ /**
11721
+ * OperationEnvelope[ConsolidationWorksheetResponse]
11722
+ */
11723
+ export type OperationEnvelopeConsolidationWorksheetResponse = {
11724
+ /**
11725
+ * Operation
11726
+ *
11727
+ * Kebab-case operation name
11728
+ */
11729
+ operation: string;
11730
+ /**
11731
+ * Operationid
11732
+ *
11733
+ * op_-prefixed ULID for audit and SSE correlation
11734
+ */
11735
+ operationId: string;
11736
+ /**
11737
+ * Status
11738
+ *
11739
+ * Operation lifecycle state
11740
+ */
11741
+ status: 'completed' | 'pending' | 'failed';
11742
+ /**
11743
+ * Command-specific result payload
11744
+ */
11745
+ result?: ConsolidationWorksheetResponse | null;
11746
+ /**
11747
+ * At
11748
+ *
11749
+ * ISO-8601 UTC timestamp
11750
+ */
11751
+ at: string;
11752
+ /**
11753
+ * Createdby
11754
+ *
11755
+ * User ID that initiated the operation
11756
+ */
11757
+ createdBy?: string | null;
11758
+ /**
11759
+ * Idempotentreplay
11760
+ *
11761
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11762
+ */
11763
+ idempotentReplay?: boolean;
11764
+ };
11765
+
11578
11766
  /**
11579
11767
  * OperationEnvelope[DeleteInformationBlockResponse]
11580
11768
  */
@@ -16439,6 +16627,38 @@ export type ReconcilingItemRegenerated = {
16439
16627
  entry_ids?: Array<string>;
16440
16628
  };
16441
16629
 
16630
+ /**
16631
+ * RecordOpeningBalanceRequest
16632
+ *
16633
+ * The balance sheet a ledger starts from.
16634
+ */
16635
+ export type RecordOpeningBalanceRequest = {
16636
+ /**
16637
+ * Entity Id
16638
+ *
16639
+ * The entity whose books start here; omit for the group parent.
16640
+ */
16641
+ entity_id?: string | null;
16642
+ /**
16643
+ * Balances
16644
+ *
16645
+ * 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.
16646
+ */
16647
+ balances: Array<OpeningBalanceInput>;
16648
+ /**
16649
+ * Equity Element Id
16650
+ *
16651
+ * 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.
16652
+ */
16653
+ equity_element_id?: string | null;
16654
+ /**
16655
+ * Memo
16656
+ *
16657
+ * The entry's memo; defaults to 'Opening balances'.
16658
+ */
16659
+ memo?: string | null;
16660
+ };
16661
+
16442
16662
  /**
16443
16663
  * RecordStatementBalanceRequest
16444
16664
  *
@@ -21586,6 +21806,106 @@ export type ViewResponse = {
21586
21806
  } | null;
21587
21807
  };
21588
21808
 
21809
+ /**
21810
+ * WorksheetColumn
21811
+ *
21812
+ * One column of the consolidation worksheet.
21813
+ */
21814
+ export type WorksheetColumn = {
21815
+ /**
21816
+ * Key
21817
+ *
21818
+ * The entity id for an entity's column; `combined` and `consolidated` for the two totals.
21819
+ */
21820
+ key: string;
21821
+ /**
21822
+ * Label
21823
+ *
21824
+ * The entity's name, or the total's.
21825
+ */
21826
+ label: string;
21827
+ /**
21828
+ * Kind
21829
+ *
21830
+ * `member`: the parent or a member consolidated in full. `combined`: the members' sum, nothing eliminated. `adjustments`: the consolidation entity's entries. `consolidated`: combined plus the adjustments. `not_summed`: an equity-method or cost member, shown beside the sum and never in it.
21831
+ */
21832
+ kind: 'member' | 'combined' | 'adjustments' | 'consolidated' | 'not_summed';
21833
+ /**
21834
+ * Entity Id
21835
+ *
21836
+ * The entity the column reads; null on a total.
21837
+ */
21838
+ entity_id?: string | null;
21839
+ /**
21840
+ * Consolidation Method
21841
+ *
21842
+ * The entity's `consolidation_method`; null on a total.
21843
+ */
21844
+ consolidation_method?: string | null;
21845
+ /**
21846
+ * Ownership Pct
21847
+ *
21848
+ * The parent's share of the entity, where it has one.
21849
+ */
21850
+ ownership_pct?: number | null;
21851
+ /**
21852
+ * In Sum
21853
+ *
21854
+ * Whether the column is part of the consolidated total.
21855
+ */
21856
+ in_sum: boolean;
21857
+ };
21858
+
21859
+ /**
21860
+ * WorksheetRow
21861
+ *
21862
+ * One line of the consolidation worksheet, a value per column.
21863
+ */
21864
+ export type WorksheetRow = {
21865
+ /**
21866
+ * Qname
21867
+ *
21868
+ * The rs-gaap concept of the line.
21869
+ */
21870
+ qname: string;
21871
+ /**
21872
+ * Name
21873
+ *
21874
+ * The line's label.
21875
+ */
21876
+ name: string;
21877
+ /**
21878
+ * Trait
21879
+ *
21880
+ * The concept's classification.
21881
+ */
21882
+ trait?: string | null;
21883
+ /**
21884
+ * Values
21885
+ *
21886
+ * One value per column, aligned with `columns`.
21887
+ */
21888
+ values: Array<number | null>;
21889
+ /**
21890
+ * Depth
21891
+ *
21892
+ * Indentation in the statement.
21893
+ */
21894
+ depth?: number;
21895
+ /**
21896
+ * Is Subtotal
21897
+ *
21898
+ * Whether the line is a total.
21899
+ */
21900
+ is_subtotal?: boolean;
21901
+ /**
21902
+ * Period Role
21903
+ *
21904
+ * On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
21905
+ */
21906
+ period_role?: string | null;
21907
+ };
21908
+
21589
21909
  /**
21590
21910
  * _CreateForecastArm
21591
21911
  *
@@ -32037,6 +32357,70 @@ export type SignOffReconciliationResponses = {
32037
32357
 
32038
32358
  export type SignOffReconciliationResponse = SignOffReconciliationResponses[keyof SignOffReconciliationResponses];
32039
32359
 
32360
+ export type RecordOpeningBalanceData = {
32361
+ body: RecordOpeningBalanceRequest;
32362
+ headers?: {
32363
+ /**
32364
+ * Idempotency-Key
32365
+ */
32366
+ 'Idempotency-Key'?: string | null;
32367
+ };
32368
+ path: {
32369
+ /**
32370
+ * Graph Id
32371
+ */
32372
+ graph_id: string;
32373
+ };
32374
+ query?: never;
32375
+ url: '/extensions/roboledger/{graph_id}/operations/record-opening-balance';
32376
+ };
32377
+
32378
+ export type RecordOpeningBalanceErrors = {
32379
+ /**
32380
+ * Invalid request
32381
+ */
32382
+ 400: ErrorResponse;
32383
+ /**
32384
+ * Authentication required
32385
+ */
32386
+ 401: ErrorResponse;
32387
+ /**
32388
+ * Access denied
32389
+ */
32390
+ 403: ErrorResponse;
32391
+ /**
32392
+ * Resource not found
32393
+ */
32394
+ 404: ErrorResponse;
32395
+ /**
32396
+ * Idempotency-Key conflict — key reused with different body
32397
+ */
32398
+ 409: ErrorResponse;
32399
+ /**
32400
+ * Validation error
32401
+ */
32402
+ 422: ErrorResponse;
32403
+ /**
32404
+ * Rate limit exceeded
32405
+ */
32406
+ 429: ErrorResponse;
32407
+ /**
32408
+ * Internal server error
32409
+ */
32410
+ 500: ErrorResponse;
32411
+ };
32412
+
32413
+ export type RecordOpeningBalanceError = RecordOpeningBalanceErrors[keyof RecordOpeningBalanceErrors];
32414
+
32415
+ export type RecordOpeningBalanceResponses = {
32416
+ /**
32417
+ * Successful Response
32418
+ */
32419
+ 200: OperationEnvelopeJournalEntryResponse;
32420
+ };
32421
+
32422
+ export type RecordOpeningBalanceResponse = RecordOpeningBalanceResponses[keyof RecordOpeningBalanceResponses];
32423
+
32040
32424
  export type UpdateJournalEntryData = {
32041
32425
  body: UpdateJournalEntryRequest;
32042
32426
  headers?: {
@@ -34021,6 +34405,70 @@ export type LiveFinancialStatementResponses = {
34021
34405
 
34022
34406
  export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
34023
34407
 
34408
+ export type ConsolidationWorksheetData = {
34409
+ body: ConsolidationWorksheetRequest;
34410
+ headers?: {
34411
+ /**
34412
+ * Idempotency-Key
34413
+ */
34414
+ 'Idempotency-Key'?: string | null;
34415
+ };
34416
+ path: {
34417
+ /**
34418
+ * Graph Id
34419
+ */
34420
+ graph_id: string;
34421
+ };
34422
+ query?: never;
34423
+ url: '/extensions/roboledger/{graph_id}/operations/consolidation-worksheet';
34424
+ };
34425
+
34426
+ export type ConsolidationWorksheetErrors = {
34427
+ /**
34428
+ * Invalid request
34429
+ */
34430
+ 400: ErrorResponse;
34431
+ /**
34432
+ * Authentication required
34433
+ */
34434
+ 401: ErrorResponse;
34435
+ /**
34436
+ * Access denied
34437
+ */
34438
+ 403: ErrorResponse;
34439
+ /**
34440
+ * Resource not found
34441
+ */
34442
+ 404: ErrorResponse;
34443
+ /**
34444
+ * Idempotency-Key conflict — key reused with different body
34445
+ */
34446
+ 409: ErrorResponse;
34447
+ /**
34448
+ * Validation error
34449
+ */
34450
+ 422: ErrorResponse;
34451
+ /**
34452
+ * Rate limit exceeded
34453
+ */
34454
+ 429: ErrorResponse;
34455
+ /**
34456
+ * Internal server error
34457
+ */
34458
+ 500: ErrorResponse;
34459
+ };
34460
+
34461
+ export type ConsolidationWorksheetError = ConsolidationWorksheetErrors[keyof ConsolidationWorksheetErrors];
34462
+
34463
+ export type ConsolidationWorksheetResponses = {
34464
+ /**
34465
+ * Successful Response
34466
+ */
34467
+ 200: OperationEnvelopeConsolidationWorksheetResponse;
34468
+ };
34469
+
34470
+ export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
34471
+
34024
34472
  export type CreatePortfolioBlockData = {
34025
34473
  body: CreatePortfolioBlockRequest;
34026
34474
  headers?: {