@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.
@@ -2532,6 +2532,112 @@ export type ConnectionResponse = {
2532
2532
  [key: string]: unknown;
2533
2533
  };
2534
2534
  };
2535
+ /**
2536
+ * ConsolidationWorksheetRequest
2537
+ *
2538
+ * Request for consolidation-worksheet (OLTP, entity graphs only).
2539
+ */
2540
+ export type ConsolidationWorksheetRequest = {
2541
+ /**
2542
+ * Statement Type
2543
+ *
2544
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement.
2545
+ */
2546
+ statement_type: string;
2547
+ /**
2548
+ * Period Start
2549
+ *
2550
+ * Explicit window start. Overrides period_type/fiscal_year.
2551
+ */
2552
+ period_start?: string | null;
2553
+ /**
2554
+ * Period End
2555
+ *
2556
+ * Explicit window end. Overrides period_type/fiscal_year.
2557
+ */
2558
+ period_end?: string | null;
2559
+ /**
2560
+ * Period Type
2561
+ *
2562
+ * annual | quarterly | instant (ignored when dates supplied)
2563
+ */
2564
+ period_type?: string | null;
2565
+ /**
2566
+ * Fiscal Year
2567
+ *
2568
+ * Fiscal year for annual window (anchored on FiscalCalendar)
2569
+ */
2570
+ fiscal_year?: number | null;
2571
+ /**
2572
+ * Limit
2573
+ *
2574
+ * Max rows returned. Defaults to the ceiling: the whole statement.
2575
+ */
2576
+ limit?: number;
2577
+ };
2578
+ /**
2579
+ * ConsolidationWorksheetResponse
2580
+ *
2581
+ * The group's statement with the entity as the column.
2582
+ */
2583
+ export type ConsolidationWorksheetResponse = {
2584
+ /**
2585
+ * Graph Id
2586
+ *
2587
+ * The graph read.
2588
+ */
2589
+ graph_id: string;
2590
+ /**
2591
+ * Entity Id
2592
+ *
2593
+ * The group parent.
2594
+ */
2595
+ entity_id: string;
2596
+ /**
2597
+ * Statement Type
2598
+ *
2599
+ * The statement rendered.
2600
+ */
2601
+ statement_type: string;
2602
+ /**
2603
+ * The window every column reads. The cash flow also pivots the prior window of equal length as its delta basis; it is not rendered.
2604
+ */
2605
+ period: PeriodSpec;
2606
+ /**
2607
+ * Columns
2608
+ *
2609
+ * 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.
2610
+ */
2611
+ columns: Array<WorksheetColumn>;
2612
+ /**
2613
+ * Rows
2614
+ *
2615
+ * The union of every column's lines in the parent's Style order; a line zero in every column is left out.
2616
+ */
2617
+ rows: Array<WorksheetRow>;
2618
+ /**
2619
+ * The guard-rail outcome for the consolidated column, the same checks live-financial-statement runs.
2620
+ */
2621
+ validation?: ValidationCheckResponse | null;
2622
+ /**
2623
+ * Unmapped Entity Ids
2624
+ *
2625
+ * Entities with no CoA mapping yet, so with no column.
2626
+ */
2627
+ unmapped_entity_ids?: Array<string>;
2628
+ /**
2629
+ * Unmapped Count
2630
+ *
2631
+ * Unmapped accounts across the summed columns.
2632
+ */
2633
+ unmapped_count?: number;
2634
+ /**
2635
+ * Truncated
2636
+ *
2637
+ * Whether `limit` cut rows.
2638
+ */
2639
+ truncated?: boolean;
2640
+ };
2535
2641
  /**
2536
2642
  * ContentLimits
2537
2643
  *
@@ -9889,6 +9995,12 @@ export type LiveFinancialStatementResponse = {
9889
9995
  * 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.
9890
9996
  */
9891
9997
  periods: Array<PeriodSpec>;
9998
+ /**
9999
+ * Omitted Periods
10000
+ *
10001
+ * 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.
10002
+ */
10003
+ omitted_periods?: Array<PeriodSpec>;
9892
10004
  /**
9893
10005
  * Facts
9894
10006
  */
@@ -10668,6 +10780,33 @@ export type OfferingRepositoryPlan = {
10668
10780
  [key: string]: number | null;
10669
10781
  } | null;
10670
10782
  };
10783
+ /**
10784
+ * OpeningBalanceInput
10785
+ *
10786
+ * One account's balance on the day the books begin, in its normal
10787
+ * direction: an asset as a debit, a liability or equity account as a credit
10788
+ * (a contra account the other way).
10789
+ */
10790
+ export type OpeningBalanceInput = {
10791
+ /**
10792
+ * Element Id
10793
+ *
10794
+ * The balance-sheet account, by id.
10795
+ */
10796
+ element_id: string;
10797
+ /**
10798
+ * Debit Amount
10799
+ *
10800
+ * Debit balance in cents.
10801
+ */
10802
+ debit_amount?: number;
10803
+ /**
10804
+ * Credit Amount
10805
+ *
10806
+ * Credit balance in cents.
10807
+ */
10808
+ credit_amount?: number;
10809
+ };
10671
10810
  /**
10672
10811
  * OperationCosts
10673
10812
  *
@@ -11313,6 +11452,51 @@ export type OperationEnvelopeComputeMetricsResponse = {
11313
11452
  */
11314
11453
  idempotentReplay?: boolean;
11315
11454
  };
11455
+ /**
11456
+ * OperationEnvelope[ConsolidationWorksheetResponse]
11457
+ */
11458
+ export type OperationEnvelopeConsolidationWorksheetResponse = {
11459
+ /**
11460
+ * Operation
11461
+ *
11462
+ * Kebab-case operation name
11463
+ */
11464
+ operation: string;
11465
+ /**
11466
+ * Operationid
11467
+ *
11468
+ * op_-prefixed ULID for audit and SSE correlation
11469
+ */
11470
+ operationId: string;
11471
+ /**
11472
+ * Status
11473
+ *
11474
+ * Operation lifecycle state
11475
+ */
11476
+ status: 'completed' | 'pending' | 'failed';
11477
+ /**
11478
+ * Command-specific result payload
11479
+ */
11480
+ result?: ConsolidationWorksheetResponse | null;
11481
+ /**
11482
+ * At
11483
+ *
11484
+ * ISO-8601 UTC timestamp
11485
+ */
11486
+ at: string;
11487
+ /**
11488
+ * Createdby
11489
+ *
11490
+ * User ID that initiated the operation
11491
+ */
11492
+ createdBy?: string | null;
11493
+ /**
11494
+ * Idempotentreplay
11495
+ *
11496
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11497
+ */
11498
+ idempotentReplay?: boolean;
11499
+ };
11316
11500
  /**
11317
11501
  * OperationEnvelope[DeleteInformationBlockResponse]
11318
11502
  */
@@ -16063,6 +16247,37 @@ export type ReconcilingItemRegenerated = {
16063
16247
  */
16064
16248
  entry_ids?: Array<string>;
16065
16249
  };
16250
+ /**
16251
+ * RecordOpeningBalanceRequest
16252
+ *
16253
+ * The balance sheet a ledger starts from.
16254
+ */
16255
+ export type RecordOpeningBalanceRequest = {
16256
+ /**
16257
+ * Entity Id
16258
+ *
16259
+ * The entity whose books start here; omit for the group parent.
16260
+ */
16261
+ entity_id?: string | null;
16262
+ /**
16263
+ * Balances
16264
+ *
16265
+ * 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.
16266
+ */
16267
+ balances: Array<OpeningBalanceInput>;
16268
+ /**
16269
+ * Equity Element Id
16270
+ *
16271
+ * 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.
16272
+ */
16273
+ equity_element_id?: string | null;
16274
+ /**
16275
+ * Memo
16276
+ *
16277
+ * The entry's memo; defaults to 'Opening balances'.
16278
+ */
16279
+ memo?: string | null;
16280
+ };
16066
16281
  /**
16067
16282
  * RecordStatementBalanceRequest
16068
16283
  *
@@ -21079,6 +21294,104 @@ export type ViewResponse = {
21079
21294
  [key: string]: ElementSummary;
21080
21295
  } | null;
21081
21296
  };
21297
+ /**
21298
+ * WorksheetColumn
21299
+ *
21300
+ * One column of the consolidation worksheet.
21301
+ */
21302
+ export type WorksheetColumn = {
21303
+ /**
21304
+ * Key
21305
+ *
21306
+ * The entity id for an entity's column; `combined` and `consolidated` for the two totals.
21307
+ */
21308
+ key: string;
21309
+ /**
21310
+ * Label
21311
+ *
21312
+ * The entity's name, or the total's.
21313
+ */
21314
+ label: string;
21315
+ /**
21316
+ * Kind
21317
+ *
21318
+ * `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.
21319
+ */
21320
+ kind: 'member' | 'combined' | 'adjustments' | 'consolidated' | 'not_summed';
21321
+ /**
21322
+ * Entity Id
21323
+ *
21324
+ * The entity the column reads; null on a total.
21325
+ */
21326
+ entity_id?: string | null;
21327
+ /**
21328
+ * Consolidation Method
21329
+ *
21330
+ * The entity's `consolidation_method`; null on a total.
21331
+ */
21332
+ consolidation_method?: string | null;
21333
+ /**
21334
+ * Ownership Pct
21335
+ *
21336
+ * The parent's share of the entity, where it has one.
21337
+ */
21338
+ ownership_pct?: number | null;
21339
+ /**
21340
+ * In Sum
21341
+ *
21342
+ * Whether the column is part of the consolidated total.
21343
+ */
21344
+ in_sum: boolean;
21345
+ };
21346
+ /**
21347
+ * WorksheetRow
21348
+ *
21349
+ * One line of the consolidation worksheet, a value per column.
21350
+ */
21351
+ export type WorksheetRow = {
21352
+ /**
21353
+ * Qname
21354
+ *
21355
+ * The rs-gaap concept of the line.
21356
+ */
21357
+ qname: string;
21358
+ /**
21359
+ * Name
21360
+ *
21361
+ * The line's label.
21362
+ */
21363
+ name: string;
21364
+ /**
21365
+ * Trait
21366
+ *
21367
+ * The concept's classification.
21368
+ */
21369
+ trait?: string | null;
21370
+ /**
21371
+ * Values
21372
+ *
21373
+ * One value per column, aligned with `columns`.
21374
+ */
21375
+ values: Array<number | null>;
21376
+ /**
21377
+ * Depth
21378
+ *
21379
+ * Indentation in the statement.
21380
+ */
21381
+ depth?: number;
21382
+ /**
21383
+ * Is Subtotal
21384
+ *
21385
+ * Whether the line is a total.
21386
+ */
21387
+ is_subtotal?: boolean;
21388
+ /**
21389
+ * Period Role
21390
+ *
21391
+ * On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
21392
+ */
21393
+ period_role?: string | null;
21394
+ };
21082
21395
  /**
21083
21396
  * _CreateForecastArm
21084
21397
  *
@@ -30624,6 +30937,65 @@ export type SignOffReconciliationResponses = {
30624
30937
  200: OperationEnvelopeReconciliationSummary;
30625
30938
  };
30626
30939
  export type SignOffReconciliationResponse = SignOffReconciliationResponses[keyof SignOffReconciliationResponses];
30940
+ export type RecordOpeningBalanceData = {
30941
+ body: RecordOpeningBalanceRequest;
30942
+ headers?: {
30943
+ /**
30944
+ * Idempotency-Key
30945
+ */
30946
+ 'Idempotency-Key'?: string | null;
30947
+ };
30948
+ path: {
30949
+ /**
30950
+ * Graph Id
30951
+ */
30952
+ graph_id: string;
30953
+ };
30954
+ query?: never;
30955
+ url: '/extensions/roboledger/{graph_id}/operations/record-opening-balance';
30956
+ };
30957
+ export type RecordOpeningBalanceErrors = {
30958
+ /**
30959
+ * Invalid request
30960
+ */
30961
+ 400: ErrorResponse;
30962
+ /**
30963
+ * Authentication required
30964
+ */
30965
+ 401: ErrorResponse;
30966
+ /**
30967
+ * Access denied
30968
+ */
30969
+ 403: ErrorResponse;
30970
+ /**
30971
+ * Resource not found
30972
+ */
30973
+ 404: ErrorResponse;
30974
+ /**
30975
+ * Idempotency-Key conflict — key reused with different body
30976
+ */
30977
+ 409: ErrorResponse;
30978
+ /**
30979
+ * Validation error
30980
+ */
30981
+ 422: ErrorResponse;
30982
+ /**
30983
+ * Rate limit exceeded
30984
+ */
30985
+ 429: ErrorResponse;
30986
+ /**
30987
+ * Internal server error
30988
+ */
30989
+ 500: ErrorResponse;
30990
+ };
30991
+ export type RecordOpeningBalanceError = RecordOpeningBalanceErrors[keyof RecordOpeningBalanceErrors];
30992
+ export type RecordOpeningBalanceResponses = {
30993
+ /**
30994
+ * Successful Response
30995
+ */
30996
+ 200: OperationEnvelopeJournalEntryResponse;
30997
+ };
30998
+ export type RecordOpeningBalanceResponse = RecordOpeningBalanceResponses[keyof RecordOpeningBalanceResponses];
30627
30999
  export type UpdateJournalEntryData = {
30628
31000
  body: UpdateJournalEntryRequest;
30629
31001
  headers?: {
@@ -32453,6 +32825,65 @@ export type LiveFinancialStatementResponses = {
32453
32825
  200: OperationEnvelopeLiveFinancialStatementResponse;
32454
32826
  };
32455
32827
  export type LiveFinancialStatementResponse2 = LiveFinancialStatementResponses[keyof LiveFinancialStatementResponses];
32828
+ export type ConsolidationWorksheetData = {
32829
+ body: ConsolidationWorksheetRequest;
32830
+ headers?: {
32831
+ /**
32832
+ * Idempotency-Key
32833
+ */
32834
+ 'Idempotency-Key'?: string | null;
32835
+ };
32836
+ path: {
32837
+ /**
32838
+ * Graph Id
32839
+ */
32840
+ graph_id: string;
32841
+ };
32842
+ query?: never;
32843
+ url: '/extensions/roboledger/{graph_id}/operations/consolidation-worksheet';
32844
+ };
32845
+ export type ConsolidationWorksheetErrors = {
32846
+ /**
32847
+ * Invalid request
32848
+ */
32849
+ 400: ErrorResponse;
32850
+ /**
32851
+ * Authentication required
32852
+ */
32853
+ 401: ErrorResponse;
32854
+ /**
32855
+ * Access denied
32856
+ */
32857
+ 403: ErrorResponse;
32858
+ /**
32859
+ * Resource not found
32860
+ */
32861
+ 404: ErrorResponse;
32862
+ /**
32863
+ * Idempotency-Key conflict — key reused with different body
32864
+ */
32865
+ 409: ErrorResponse;
32866
+ /**
32867
+ * Validation error
32868
+ */
32869
+ 422: ErrorResponse;
32870
+ /**
32871
+ * Rate limit exceeded
32872
+ */
32873
+ 429: ErrorResponse;
32874
+ /**
32875
+ * Internal server error
32876
+ */
32877
+ 500: ErrorResponse;
32878
+ };
32879
+ export type ConsolidationWorksheetError = ConsolidationWorksheetErrors[keyof ConsolidationWorksheetErrors];
32880
+ export type ConsolidationWorksheetResponses = {
32881
+ /**
32882
+ * Successful Response
32883
+ */
32884
+ 200: OperationEnvelopeConsolidationWorksheetResponse;
32885
+ };
32886
+ export type ConsolidationWorksheetResponse2 = ConsolidationWorksheetResponses[keyof ConsolidationWorksheetResponses];
32456
32887
  export type CreatePortfolioBlockData = {
32457
32888
  body: CreatePortfolioBlockRequest;
32458
32889
  headers?: {