@robosystems/client 2.7.0 → 2.8.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.d.ts CHANGED
@@ -678,6 +678,12 @@ export type BackfillPeriodOutcome = {
678
678
  * Compile monthly statement history behind the close boundary.
679
679
  */
680
680
  export type BackfillPlanHistoryOperation = {
681
+ /**
682
+ * Entity Id
683
+ *
684
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
685
+ */
686
+ entity_id?: string | null;
681
687
  /**
682
688
  * Start Period
683
689
  *
@@ -1628,6 +1634,12 @@ export type ClassificationLite = {
1628
1634
  * :class:`ClosePeriodRequest`.
1629
1635
  */
1630
1636
  export type ClosePeriodOperation = {
1637
+ /**
1638
+ * Entity Id
1639
+ *
1640
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
1641
+ */
1642
+ entity_id?: string | null;
1631
1643
  /**
1632
1644
  * Note
1633
1645
  *
@@ -2455,12 +2467,146 @@ export type CreateConnectionRequest = {
2455
2467
  mercury_config?: MercuryConnectionConfig | null;
2456
2468
  plaid_config?: PlaidConnectionConfig | null;
2457
2469
  };
2470
+ /**
2471
+ * CreateEntityRequest
2472
+ *
2473
+ * Add an entity to the graph's reporting group.
2474
+ *
2475
+ * The new entity is a subsidiary of `parent_entity_id`, default the group
2476
+ * parent, and keeps its own books: give it a chart next
2477
+ * (`initialize-chart-of-accounts` with `entity_id`) and a calendar
2478
+ * (`initialize`), then name it with `entity_id` on any ledger operation.
2479
+ * A graph created without an entity gets this one as its group parent.
2480
+ * There is no cap on entities in a graph; capacity is the tier's.
2481
+ */
2482
+ export type CreateEntityRequest = {
2483
+ /**
2484
+ * Name
2485
+ *
2486
+ * Display name.
2487
+ */
2488
+ name: string;
2489
+ /**
2490
+ * Legal Name
2491
+ *
2492
+ * Registered legal name. Defaults to `name`.
2493
+ */
2494
+ legal_name?: string | null;
2495
+ /**
2496
+ * Entity Type
2497
+ *
2498
+ * Legal form: `corporation`, `llc`, `partnership`, `sole_proprietorship`, `non_profit`. Picks the default Reporting Style (partnership and llc have equity-form Styles of their own; anything else is corporate) and the equity rows of a chart template.
2499
+ */
2500
+ entity_type?: string | null;
2501
+ /**
2502
+ * Reporting Style Id
2503
+ *
2504
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
2505
+ */
2506
+ reporting_style_id?: string | null;
2507
+ /**
2508
+ * Parent Entity Id
2509
+ *
2510
+ * The entity this one is held under. Omit for the group parent; name a subsidiary to nest a sub-group under it.
2511
+ */
2512
+ parent_entity_id?: string | null;
2513
+ /**
2514
+ * Ownership Pct
2515
+ *
2516
+ * The parent's share of this entity, as a percent (100 = wholly owned). Omit when not recorded. Refused on a graph's first entity, which becomes the group parent.
2517
+ */
2518
+ ownership_pct?: number | null;
2519
+ /**
2520
+ * Ticker
2521
+ *
2522
+ * Short symbol, unique in the graph; it prefixes the entity's account names (`coa-<ticker>:1000`). Derived from the name's initials when omitted.
2523
+ */
2524
+ ticker?: string | null;
2525
+ /**
2526
+ * Uri
2527
+ *
2528
+ * Canonical URL / external identifier.
2529
+ */
2530
+ uri?: string | null;
2531
+ /**
2532
+ * Cik
2533
+ */
2534
+ cik?: string | null;
2535
+ /**
2536
+ * Sic
2537
+ */
2538
+ sic?: string | null;
2539
+ /**
2540
+ * Sic Description
2541
+ */
2542
+ sic_description?: string | null;
2543
+ /**
2544
+ * Category
2545
+ */
2546
+ category?: string | null;
2547
+ /**
2548
+ * State Of Incorporation
2549
+ */
2550
+ state_of_incorporation?: string | null;
2551
+ /**
2552
+ * Fiscal Year End
2553
+ *
2554
+ * Fiscal year-end as MM-DD. Defaults to the parent's: a graph has one fiscal cadence, and every entity's calendar follows it.
2555
+ */
2556
+ fiscal_year_end?: string | null;
2557
+ /**
2558
+ * Tax Id
2559
+ */
2560
+ tax_id?: string | null;
2561
+ /**
2562
+ * Lei
2563
+ */
2564
+ lei?: string | null;
2565
+ /**
2566
+ * Industry
2567
+ */
2568
+ industry?: string | null;
2569
+ /**
2570
+ * Phone
2571
+ */
2572
+ phone?: string | null;
2573
+ /**
2574
+ * Website
2575
+ */
2576
+ website?: string | null;
2577
+ /**
2578
+ * Address Line1
2579
+ */
2580
+ address_line1?: string | null;
2581
+ /**
2582
+ * Address City
2583
+ */
2584
+ address_city?: string | null;
2585
+ /**
2586
+ * Address State
2587
+ */
2588
+ address_state?: string | null;
2589
+ /**
2590
+ * Address Postal Code
2591
+ */
2592
+ address_postal_code?: string | null;
2593
+ /**
2594
+ * Address Country
2595
+ */
2596
+ address_country?: string | null;
2597
+ };
2458
2598
  /**
2459
2599
  * CreateEventBlockRequest
2460
2600
  *
2461
2601
  * Write surface for a single business event.
2462
2602
  */
2463
2603
  export type CreateEventBlockRequest = {
2604
+ /**
2605
+ * Entity Id
2606
+ *
2607
+ * The entity whose books the event lands in, by id; every GL row its handler writes follows it. Omit for the group parent.
2608
+ */
2609
+ entity_id?: string | null;
2464
2610
  /**
2465
2611
  * Event Type
2466
2612
  *
@@ -2941,6 +3087,12 @@ export type CreatePublishListRequest = {
2941
3087
  * inputs to period generation.
2942
3088
  */
2943
3089
  export type CreateReportRequest = {
3090
+ /**
3091
+ * Entity Id
3092
+ *
3093
+ * The entity the report is for, by id. Omit for the entity whose chart `mapping_id` maps from (the group parent on a one-entity graph). Named alongside a mapping of another entity's chart, it is refused.
3094
+ */
3095
+ entity_id?: string | null;
2944
3096
  /**
2945
3097
  * Name
2946
3098
  *
@@ -5954,13 +6106,19 @@ export type FinancialStatementAnalysisResponse = {
5954
6106
  /**
5955
6107
  * FiscalCalendarResponse
5956
6108
  *
5957
- * Current fiscal calendar state for a graph.
6109
+ * Current fiscal calendar state for one entity of a graph.
5958
6110
  */
5959
6111
  export type FiscalCalendarResponse = {
5960
6112
  /**
5961
6113
  * Graph Id
5962
6114
  */
5963
6115
  graph_id: string;
6116
+ /**
6117
+ * Entity Id
6118
+ *
6119
+ * The entity whose calendar this is.
6120
+ */
6121
+ entity_id?: string | null;
5964
6122
  /**
5965
6123
  * Fiscal Year Start Month
5966
6124
  */
@@ -7675,13 +7833,20 @@ export type InitialEntityData = {
7675
7833
  *
7676
7834
  * Create the graph's chart of accounts from a shipped template.
7677
7835
  *
7678
- * Refused (409) when the graph already has an active `chart_of_accounts`
7836
+ * Refused (409) when the entity already has an active `chart_of_accounts`
7679
7837
  * taxonomy — a QuickBooks-synced tenant never needs this, and a chart is
7680
- * never replaced. The template's equity rows are mapped by the entity's
7838
+ * never replaced. Each entity of the group keeps its own chart; omit
7839
+ * `entity_id` for the group parent. The template's equity rows are mapped by the entity's
7681
7840
  * legal form (`entity_type`: corporation / llc / partnership); omit it
7682
7841
  * to use the graph's primary entity, falling back to corporation.
7683
7842
  */
7684
7843
  export type InitializeChartOfAccountsRequest = {
7844
+ /**
7845
+ * Entity Id
7846
+ *
7847
+ * The entity to give a chart to, by id. Omit for the group parent. A sibling already having one is no bar.
7848
+ */
7849
+ entity_id?: string | null;
7685
7850
  /**
7686
7851
  * Template
7687
7852
  *
@@ -7765,6 +7930,12 @@ export type InitializeChartOfAccountsResponse = {
7765
7930
  * closing toward. Set independently via `set-close-target`.
7766
7931
  */
7767
7932
  export type InitializeLedgerRequest = {
7933
+ /**
7934
+ * Entity Id
7935
+ *
7936
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
7937
+ */
7938
+ entity_id?: string | null;
7768
7939
  /**
7769
7940
  * Closed Through
7770
7941
  *
@@ -8379,6 +8550,12 @@ export type LedgerEntityResponse = {
8379
8550
  * Parent entity ID for subsidiaries; null for top-level.
8380
8551
  */
8381
8552
  parent_entity_id?: string | null;
8553
+ /**
8554
+ * Ownership Pct
8555
+ *
8556
+ * The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
8557
+ */
8558
+ ownership_pct?: number | null;
8382
8559
  /**
8383
8560
  * Source
8384
8561
  *
@@ -8761,6 +8938,12 @@ export type LineItemMetadataPredicate = {
8761
8938
  * explicitly.
8762
8939
  */
8763
8940
  export type LinkEntityTaxonomyRequest = {
8941
+ /**
8942
+ * Entity Id
8943
+ *
8944
+ * The entity to link, by id. Omit for the group parent.
8945
+ */
8946
+ entity_id?: string | null;
8764
8947
  /**
8765
8948
  * Taxonomy Id
8766
8949
  *
@@ -8888,6 +9071,12 @@ export type ListTableFilesResponse = {
8888
9071
  * Request for live-financial-statement (OLTP, entity graphs only).
8889
9072
  */
8890
9073
  export type LiveFinancialStatementRequest = {
9074
+ /**
9075
+ * Entity Id
9076
+ *
9077
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
9078
+ */
9079
+ entity_id?: string | null;
8891
9080
  /**
8892
9081
  * Statement Type
8893
9082
  *
@@ -8918,6 +9107,12 @@ export type LiveFinancialStatementRequest = {
8918
9107
  * Fiscal year for annual window (anchored on FiscalCalendar)
8919
9108
  */
8920
9109
  fiscal_year?: number | null;
9110
+ /**
9111
+ * Consolidated
9112
+ *
9113
+ * A combined statement, not a consolidation: every entity of the reporting group rendered under the group parent's Reporting Style and summed per rs-gaap concept, with nothing eliminated between them. Only on the group parent (422 on a subsidiary). An entity with no CoA mapping yet contributes nothing and is left out of `combined_entity_ids`.
9114
+ */
9115
+ consolidated?: boolean;
8921
9116
  /**
8922
9117
  * Limit
8923
9118
  *
@@ -8935,6 +9130,24 @@ export type LiveFinancialStatementResponse = {
8935
9130
  * Graph Id
8936
9131
  */
8937
9132
  graph_id: string;
9133
+ /**
9134
+ * Entity Id
9135
+ *
9136
+ * The entity whose books were rendered.
9137
+ */
9138
+ entity_id?: string | null;
9139
+ /**
9140
+ * Consolidated
9141
+ *
9142
+ * Whether the group's entities were summed into this: a combined statement, not a consolidation — nothing is eliminated between them.
9143
+ */
9144
+ consolidated?: boolean;
9145
+ /**
9146
+ * Combined Entity Ids
9147
+ *
9148
+ * The entities summed into a combined statement, parent first.
9149
+ */
9150
+ combined_entity_ids?: Array<string>;
8938
9151
  /**
8939
9152
  * Statement Type
8940
9153
  */
@@ -15138,6 +15351,12 @@ export type RenderingRowLite = {
15138
15351
  * Reopen a closed fiscal period.
15139
15352
  */
15140
15353
  export type ReopenPeriodOperation = {
15354
+ /**
15355
+ * Entity Id
15356
+ *
15357
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
15358
+ */
15359
+ entity_id?: string | null;
15141
15360
  /**
15142
15361
  * Reason
15143
15362
  *
@@ -15252,10 +15471,16 @@ export type ReportResponse = {
15252
15471
  * Structures available for this report's taxonomy — renderable sections (BS / IS / CF / Equity / Schedules).
15253
15472
  */
15254
15473
  structures?: Array<StructureSummary>;
15474
+ /**
15475
+ * Entity Id
15476
+ *
15477
+ * The entity the report is about. Null on a shared-in copy, and on a report from before entities were recorded, which is the group parent's.
15478
+ */
15479
+ entity_id?: string | null;
15255
15480
  /**
15256
15481
  * Entity Name
15257
15482
  *
15258
- * Display name of the primary entity the report is tagged to.
15483
+ * Display name of the entity the report is tagged to.
15259
15484
  */
15260
15485
  entity_name?: string | null;
15261
15486
  /**
@@ -16711,6 +16936,12 @@ export type ServiceOfferingsResponse = {
16711
16936
  * SetCloseTargetOperation
16712
16937
  */
16713
16938
  export type SetCloseTargetOperation = {
16939
+ /**
16940
+ * Entity Id
16941
+ *
16942
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
16943
+ */
16944
+ entity_id?: string | null;
16714
16945
  /**
16715
16946
  * Period
16716
16947
  *
@@ -18458,15 +18689,20 @@ export type UpdateAgentRequest = {
18458
18689
  /**
18459
18690
  * UpdateEntityRequest
18460
18691
  *
18461
- * Update the graph's primary entity. All fields are optional —
18462
- * pass only what changes. Identifiers (CIK, LEI, tax_id) are typically
18463
- * set once at onboarding; address fields are flattened to make them
18464
- * easy to project into reporting forms (1099, state filings).
18692
+ * Update an entity of the graph's reporting group. All fields are
18693
+ * optional — pass only what changes. Identifiers (CIK, LEI, tax_id) are
18694
+ * typically set once at onboarding; address fields are flattened to make
18695
+ * them easy to project into reporting forms (1099, state filings).
18465
18696
  *
18466
- * The graph is implicit (URL path) — there's no `entity_id` field
18467
- * because the operation always targets the graph's primary entity.
18697
+ * Omit `entity_id` to target the group parent.
18468
18698
  */
18469
18699
  export type UpdateEntityRequest = {
18700
+ /**
18701
+ * Entity Id
18702
+ *
18703
+ * The entity to update. Omit to target the group parent — the single-entity default.
18704
+ */
18705
+ entity_id?: string | null;
18470
18706
  /**
18471
18707
  * Name
18472
18708
  */
@@ -18557,6 +18793,12 @@ export type UpdateEntityRequest = {
18557
18793
  * Address Country
18558
18794
  */
18559
18795
  address_country?: string | null;
18796
+ /**
18797
+ * Ownership Pct
18798
+ *
18799
+ * The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph.
18800
+ */
18801
+ ownership_pct?: number | null;
18560
18802
  };
18561
18803
  /**
18562
18804
  * UpdateEventBlockRequest
@@ -25923,55 +26165,6 @@ export type GetGraphCapacityResponses = {
25923
26165
  200: GraphCapacityResponse;
25924
26166
  };
25925
26167
  export type GetGraphCapacityResponse = GetGraphCapacityResponses[keyof GetGraphCapacityResponses];
25926
- export type SelectGraphData = {
25927
- body?: never;
25928
- path: {
25929
- /**
25930
- * Graph Id
25931
- */
25932
- graph_id: string;
25933
- };
25934
- query?: never;
25935
- url: '/v1/graphs/{graph_id}/select';
25936
- };
25937
- export type SelectGraphErrors = {
25938
- /**
25939
- * Invalid request
25940
- */
25941
- 400: ErrorResponse;
25942
- /**
25943
- * Authentication required
25944
- */
25945
- 401: ErrorResponse;
25946
- /**
25947
- * Access denied
25948
- */
25949
- 403: ErrorResponse;
25950
- /**
25951
- * Resource not found
25952
- */
25953
- 404: ErrorResponse;
25954
- /**
25955
- * Validation Error
25956
- */
25957
- 422: HttpValidationError;
25958
- /**
25959
- * Rate limit exceeded
25960
- */
25961
- 429: ErrorResponse;
25962
- /**
25963
- * Internal server error
25964
- */
25965
- 500: ErrorResponse;
25966
- };
25967
- export type SelectGraphError = SelectGraphErrors[keyof SelectGraphErrors];
25968
- export type SelectGraphResponses = {
25969
- /**
25970
- * Successful Response
25971
- */
25972
- 200: SuccessResponse;
25973
- };
25974
- export type SelectGraphResponse = SelectGraphResponses[keyof SelectGraphResponses];
25975
26168
  export type ValidateSchemaData = {
25976
26169
  /**
25977
26170
  * Schema definition to validate
@@ -26957,6 +27150,65 @@ export type InitializeChartOfAccountsResponses = {
26957
27150
  200: OperationEnvelopeInitializeChartOfAccountsResponse;
26958
27151
  };
26959
27152
  export type InitializeChartOfAccountsResponse2 = InitializeChartOfAccountsResponses[keyof InitializeChartOfAccountsResponses];
27153
+ export type CreateEntityData = {
27154
+ body: CreateEntityRequest;
27155
+ headers?: {
27156
+ /**
27157
+ * Idempotency-Key
27158
+ */
27159
+ 'Idempotency-Key'?: string | null;
27160
+ };
27161
+ path: {
27162
+ /**
27163
+ * Graph Id
27164
+ */
27165
+ graph_id: string;
27166
+ };
27167
+ query?: never;
27168
+ url: '/extensions/roboledger/{graph_id}/operations/create-entity';
27169
+ };
27170
+ export type CreateEntityErrors = {
27171
+ /**
27172
+ * Invalid request
27173
+ */
27174
+ 400: ErrorResponse;
27175
+ /**
27176
+ * Authentication required
27177
+ */
27178
+ 401: ErrorResponse;
27179
+ /**
27180
+ * Access denied
27181
+ */
27182
+ 403: ErrorResponse;
27183
+ /**
27184
+ * Resource not found
27185
+ */
27186
+ 404: ErrorResponse;
27187
+ /**
27188
+ * Idempotency-Key conflict — key reused with different body
27189
+ */
27190
+ 409: ErrorResponse;
27191
+ /**
27192
+ * Validation error
27193
+ */
27194
+ 422: ErrorResponse;
27195
+ /**
27196
+ * Rate limit exceeded
27197
+ */
27198
+ 429: ErrorResponse;
27199
+ /**
27200
+ * Internal server error
27201
+ */
27202
+ 500: ErrorResponse;
27203
+ };
27204
+ export type CreateEntityError = CreateEntityErrors[keyof CreateEntityErrors];
27205
+ export type CreateEntityResponses = {
27206
+ /**
27207
+ * Successful Response
27208
+ */
27209
+ 200: OperationEnvelopeLedgerEntityResponse;
27210
+ };
27211
+ export type CreateEntityResponse = CreateEntityResponses[keyof CreateEntityResponses];
26960
27212
  export type UpdateEntityData = {
26961
27213
  body: UpdateEntityRequest;
26962
27214
  headers?: {