@robosystems/client 2.14.2 → 2.16.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/artifacts/LedgerClient.d.ts +18 -1
- package/artifacts/LedgerClient.js +19 -0
- package/artifacts/LedgerClient.ts +40 -0
- package/artifacts/graphql/generated/graphql.d.ts +31 -0
- package/artifacts/graphql/generated/graphql.js +108 -2
- package/artifacts/graphql/generated/graphql.ts +141 -0
- package/artifacts/graphql/queries/ledger/entities.js +4 -0
- package/artifacts/graphql/queries/ledger/entities.ts +4 -0
- package/artifacts/graphql/queries/ledger/entity.js +4 -0
- package/artifacts/graphql/queries/ledger/entity.ts +4 -0
- package/artifacts/graphql/queries/ledger/informationBlock.d.ts +7 -0
- package/artifacts/graphql/queries/ledger/informationBlock.js +37 -1
- package/artifacts/graphql/queries/ledger/informationBlock.ts +37 -0
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +4 -4
- package/sdk/sdk.gen.js +4 -4
- package/sdk/sdk.gen.ts +4 -4
- package/sdk/types.gen.d.ts +98 -8
- package/sdk/types.gen.ts +98 -8
- package/sdk.gen.d.ts +4 -4
- package/sdk.gen.js +4 -4
- package/sdk.gen.ts +4 -4
- package/types.gen.d.ts +98 -8
- package/types.gen.ts +98 -8
package/sdk.gen.js
CHANGED
|
@@ -1773,7 +1773,7 @@ exports.initializeChartOfAccounts = initializeChartOfAccounts;
|
|
|
1773
1773
|
/**
|
|
1774
1774
|
* Create Entity
|
|
1775
1775
|
*
|
|
1776
|
-
* Add an entity to the graph's reporting group: a subsidiary under `parent_entity_id` (default the group parent) that keeps its own books, chart of accounts and close, on the group's fiscal cadence. A graph created without an entity gets this one as its group parent. Creates the entity row only — give it a chart next (initialize-chart-of-accounts with `entity_id`) and a calendar (initialize with `entity_id`); from then on every ledger operation takes `entity_id` to act in its books, and omitting it means the group parent. The Reporting Style follows `entity_type` unless `reporting_style_id` names one. `ticker` prefixes the entity's account names and must be unique in the graph (409). There is no cap on entities: a graph is one reporting group, and everyone with access to it sees every entity.
|
|
1776
|
+
* Add an entity to the graph's reporting group: a subsidiary under `parent_entity_id` (default the group parent) that keeps its own books, chart of accounts and close, on the group's fiscal cadence. A graph created without an entity gets this one as its group parent. Creates the entity row only — give it a chart next (initialize-chart-of-accounts with `entity_id`) and a calendar (initialize with `entity_id`); from then on every ledger operation takes `entity_id` to act in its books, and omitting it means the group parent. The Reporting Style follows `entity_type` unless `reporting_style_id` names one. `ticker` prefixes the entity's account names and must be unique in the graph (409). There is no cap on entities: a graph is one reporting group, and everyone with access to it sees every entity. `ownership_pct` implies the `consolidation_method` (50 and above full, 20 to 50 equity, below 20 cost) unless one is given; `entity_role: consolidation` makes this the group's entity for consolidating entries, read by the consolidated statements only; `joined_on` dates an acquired subsidiary's membership.
|
|
1777
1777
|
*
|
|
1778
1778
|
* **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.
|
|
1779
1779
|
*/
|
|
@@ -1790,7 +1790,7 @@ exports.createEntity = createEntity;
|
|
|
1790
1790
|
/**
|
|
1791
1791
|
* Update Entity
|
|
1792
1792
|
*
|
|
1793
|
-
* Update an entity of the graph's reporting group. Only provided (non-null) fields are updated. Omit `entity_id` to target the group parent; name a subsidiary's id to edit it. `ownership_pct` is refused on the group parent (422), and `ticker` must stay unique in the graph (409).
|
|
1793
|
+
* Update an entity of the graph's reporting group. Only provided (non-null) fields are updated. Omit `entity_id` to target the group parent; name a subsidiary's id to edit it. `ownership_pct` is refused on the group parent (422), and `ticker` must stay unique in the graph (409). `consolidation_method` overrides the treatment the share implies (a new share re-derives it unless both are given), `entity_role: consolidation` marks the group's entity for consolidating entries, and `joined_on` / `left_on` bound its membership by month — set `left_on` when a subsidiary leaves the group and its history stays readable under it.
|
|
1794
1794
|
*
|
|
1795
1795
|
* **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.
|
|
1796
1796
|
*/
|
|
@@ -1841,7 +1841,7 @@ exports.linkBankAccount = linkBankAccount;
|
|
|
1841
1841
|
/**
|
|
1842
1842
|
* Create Taxonomy Block
|
|
1843
1843
|
*
|
|
1844
|
-
* Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules. Dispatches by `taxonomy_type` — `chart_of_accounts` (declarative tenant CoA), `reporting_extension`, and `custom_ontology` are supported; `reporting_standard` is library-origin (501). `reporting_extension` / `custom_ontology` authoring may be disabled per environment (TAXONOMY_AUTHORING_ENABLED) — disabled surfaces 403. NOT the path for a functional close schedule: a structure with block_type='schedule' here is a bare ontology row with none of the schedule machinery (per-period facts, schedule_entry_due obligations, closing-entry generator). To create a working schedule use create-information-block(block_type='schedule').
|
|
1844
|
+
* Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules. Dispatches by `taxonomy_type` — `chart_of_accounts` (declarative tenant CoA), `reporting_extension`, and `custom_ontology` are supported; `reporting_standard` is library-origin (501). `reporting_extension` / `custom_ontology` authoring may be disabled per environment (TAXONOMY_AUTHORING_ENABLED) — disabled surfaces 403. A `reporting_extension` structure with `extends_network` adds rows to the entity's balance sheet, income statement, cash flow or equity statement: its arcs layer onto that Reporting Style network, anchored and checked when authored (refused with a reason, 422). Prefer an rs-gaap concept for a row — any library concept may be named, including ones not yet in this graph — and give a tenant concept a `parent_ref` to the rs-gaap concept it refines. NOT the path for a functional close schedule: a structure with block_type='schedule' here is a bare ontology row with none of the schedule machinery (per-period facts, schedule_entry_due obligations, closing-entry generator). To create a working schedule use create-information-block(block_type='schedule').
|
|
1845
1845
|
*
|
|
1846
1846
|
* **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.
|
|
1847
1847
|
*/
|
|
@@ -2895,7 +2895,7 @@ exports.readText = readText;
|
|
|
2895
2895
|
/**
|
|
2896
2896
|
* Live Financial Statement
|
|
2897
2897
|
*
|
|
2898
|
-
* Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. One entity's books: `entity_id` names a subsidiary, omitted means the group parent
|
|
2898
|
+
* Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. One entity's books: `entity_id` names a subsidiary, omitted means the group parent. On the parent, `scope: combined` sums every member consolidated in full at the rs-gaap concepts for the months each was a member, nothing eliminated, and `scope: consolidated` adds the consolidation entity's entries — the eliminations and noncontrolling interest. Rejected on shared-repository graphs; those should use `financial-statement-analysis` instead.
|
|
2899
2899
|
*
|
|
2900
2900
|
* **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.
|
|
2901
2901
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -1784,7 +1784,7 @@ export const initializeChartOfAccounts = <ThrowOnError extends boolean = false>(
|
|
|
1784
1784
|
/**
|
|
1785
1785
|
* Create Entity
|
|
1786
1786
|
*
|
|
1787
|
-
* Add an entity to the graph's reporting group: a subsidiary under `parent_entity_id` (default the group parent) that keeps its own books, chart of accounts and close, on the group's fiscal cadence. A graph created without an entity gets this one as its group parent. Creates the entity row only — give it a chart next (initialize-chart-of-accounts with `entity_id`) and a calendar (initialize with `entity_id`); from then on every ledger operation takes `entity_id` to act in its books, and omitting it means the group parent. The Reporting Style follows `entity_type` unless `reporting_style_id` names one. `ticker` prefixes the entity's account names and must be unique in the graph (409). There is no cap on entities: a graph is one reporting group, and everyone with access to it sees every entity.
|
|
1787
|
+
* Add an entity to the graph's reporting group: a subsidiary under `parent_entity_id` (default the group parent) that keeps its own books, chart of accounts and close, on the group's fiscal cadence. A graph created without an entity gets this one as its group parent. Creates the entity row only — give it a chart next (initialize-chart-of-accounts with `entity_id`) and a calendar (initialize with `entity_id`); from then on every ledger operation takes `entity_id` to act in its books, and omitting it means the group parent. The Reporting Style follows `entity_type` unless `reporting_style_id` names one. `ticker` prefixes the entity's account names and must be unique in the graph (409). There is no cap on entities: a graph is one reporting group, and everyone with access to it sees every entity. `ownership_pct` implies the `consolidation_method` (50 and above full, 20 to 50 equity, below 20 cost) unless one is given; `entity_role: consolidation` makes this the group's entity for consolidating entries, read by the consolidated statements only; `joined_on` dates an acquired subsidiary's membership.
|
|
1788
1788
|
*
|
|
1789
1789
|
* **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.
|
|
1790
1790
|
*/
|
|
@@ -1801,7 +1801,7 @@ export const createEntity = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
1801
1801
|
/**
|
|
1802
1802
|
* Update Entity
|
|
1803
1803
|
*
|
|
1804
|
-
* Update an entity of the graph's reporting group. Only provided (non-null) fields are updated. Omit `entity_id` to target the group parent; name a subsidiary's id to edit it. `ownership_pct` is refused on the group parent (422), and `ticker` must stay unique in the graph (409).
|
|
1804
|
+
* Update an entity of the graph's reporting group. Only provided (non-null) fields are updated. Omit `entity_id` to target the group parent; name a subsidiary's id to edit it. `ownership_pct` is refused on the group parent (422), and `ticker` must stay unique in the graph (409). `consolidation_method` overrides the treatment the share implies (a new share re-derives it unless both are given), `entity_role: consolidation` marks the group's entity for consolidating entries, and `joined_on` / `left_on` bound its membership by month — set `left_on` when a subsidiary leaves the group and its history stays readable under it.
|
|
1805
1805
|
*
|
|
1806
1806
|
* **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.
|
|
1807
1807
|
*/
|
|
@@ -1852,7 +1852,7 @@ export const linkBankAccount = <ThrowOnError extends boolean = false>(options: O
|
|
|
1852
1852
|
/**
|
|
1853
1853
|
* Create Taxonomy Block
|
|
1854
1854
|
*
|
|
1855
|
-
* Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules. Dispatches by `taxonomy_type` — `chart_of_accounts` (declarative tenant CoA), `reporting_extension`, and `custom_ontology` are supported; `reporting_standard` is library-origin (501). `reporting_extension` / `custom_ontology` authoring may be disabled per environment (TAXONOMY_AUTHORING_ENABLED) — disabled surfaces 403. NOT the path for a functional close schedule: a structure with block_type='schedule' here is a bare ontology row with none of the schedule machinery (per-period facts, schedule_entry_due obligations, closing-entry generator). To create a working schedule use create-information-block(block_type='schedule').
|
|
1855
|
+
* Create a taxonomy block atomically: one envelope carrying the taxonomy row plus its structures, elements, associations, and rules. Dispatches by `taxonomy_type` — `chart_of_accounts` (declarative tenant CoA), `reporting_extension`, and `custom_ontology` are supported; `reporting_standard` is library-origin (501). `reporting_extension` / `custom_ontology` authoring may be disabled per environment (TAXONOMY_AUTHORING_ENABLED) — disabled surfaces 403. A `reporting_extension` structure with `extends_network` adds rows to the entity's balance sheet, income statement, cash flow or equity statement: its arcs layer onto that Reporting Style network, anchored and checked when authored (refused with a reason, 422). Prefer an rs-gaap concept for a row — any library concept may be named, including ones not yet in this graph — and give a tenant concept a `parent_ref` to the rs-gaap concept it refines. NOT the path for a functional close schedule: a structure with block_type='schedule' here is a bare ontology row with none of the schedule machinery (per-period facts, schedule_entry_due obligations, closing-entry generator). To create a working schedule use create-information-block(block_type='schedule').
|
|
1856
1856
|
*
|
|
1857
1857
|
* **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.
|
|
1858
1858
|
*/
|
|
@@ -2906,7 +2906,7 @@ export const readText = <ThrowOnError extends boolean = false>(options: Options<
|
|
|
2906
2906
|
/**
|
|
2907
2907
|
* Live Financial Statement
|
|
2908
2908
|
*
|
|
2909
|
-
* Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. One entity's books: `entity_id` names a subsidiary, omitted means the group parent
|
|
2909
|
+
* Generate an ad-hoc financial statement directly from the tenant's OLTP ledger data using the active CoA→GAAP mapping. This is the authoritative source for RoboLedger entity graphs — no graph materialization required. One entity's books: `entity_id` names a subsidiary, omitted means the group parent. On the parent, `scope: combined` sums every member consolidated in full at the rs-gaap concepts for the months each was a member, nothing eliminated, and `scope: consolidated` adds the consolidation entity's entries — the eliminations and noncontrolling interest. Rejected on shared-repository graphs; those should use `financial-statement-analysis` instead.
|
|
2910
2910
|
*
|
|
2911
2911
|
* **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.
|
|
2912
2912
|
*/
|
package/types.gen.d.ts
CHANGED
|
@@ -2874,6 +2874,24 @@ export type CreateEntityRequest = {
|
|
|
2874
2874
|
* 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.
|
|
2875
2875
|
*/
|
|
2876
2876
|
ownership_pct?: number | null;
|
|
2877
|
+
/**
|
|
2878
|
+
* Consolidation Method
|
|
2879
|
+
*
|
|
2880
|
+
* How the group's consolidated statements treat this entity: `full` (its books are summed and an outside owner's share is carried as noncontrolling interest), `equity` (one investment line and one income line), `cost` (an investment at cost) or `none` (the group parent, the consolidation entity, a linked counterparty). Derived from `ownership_pct` when not given — 50 and above `full`, 20 to 50 `equity`, below 20 `cost`, unrecorded `full` — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method. Omit to derive it; a graph's first entity and a `consolidation` entity take `none`.
|
|
2881
|
+
*/
|
|
2882
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
2883
|
+
/**
|
|
2884
|
+
* Entity Role
|
|
2885
|
+
*
|
|
2886
|
+
* `operating` keeps a company's books. `consolidation` is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is `none`. Default `operating`; a graph's first entity, its group parent, is always operating. Start a consolidation entity's chart from the `consolidation` template.
|
|
2887
|
+
*/
|
|
2888
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
2889
|
+
/**
|
|
2890
|
+
* Joined On
|
|
2891
|
+
*
|
|
2892
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. 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. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it.
|
|
2893
|
+
*/
|
|
2894
|
+
joined_on?: string | null;
|
|
2877
2895
|
/**
|
|
2878
2896
|
* Ticker
|
|
2879
2897
|
*
|
|
@@ -8342,9 +8360,9 @@ export type InitializeChartOfAccountsRequest = {
|
|
|
8342
8360
|
/**
|
|
8343
8361
|
* Template
|
|
8344
8362
|
*
|
|
8345
|
-
* Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue).
|
|
8363
|
+
* Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue), `consolidation` (a group's consolidation entity: the eliminated investment, intercompany and subsidiary-equity rows, noncontrolling interest and its share of income — the adjustments column, never an operating company's chart).
|
|
8346
8364
|
*/
|
|
8347
|
-
template: 'saas' | 'services' | 'product';
|
|
8365
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8348
8366
|
/**
|
|
8349
8367
|
* Entity Type
|
|
8350
8368
|
*
|
|
@@ -8375,7 +8393,7 @@ export type InitializeChartOfAccountsResponse = {
|
|
|
8375
8393
|
/**
|
|
8376
8394
|
* Template
|
|
8377
8395
|
*/
|
|
8378
|
-
template: 'saas' | 'services' | 'product';
|
|
8396
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8379
8397
|
/**
|
|
8380
8398
|
* Entity Type
|
|
8381
8399
|
*
|
|
@@ -8750,7 +8768,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8750
8768
|
/**
|
|
8751
8769
|
* Flow Qname
|
|
8752
8770
|
*
|
|
8753
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. Refused when it is not a row of the entity's cash flow statement.
|
|
8771
|
+
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. On the group's consolidation entity, which moves no cash, every tagged line counts on its own, cash-effect signed (a credit is an inflow), so an elimination offsets the flow a member's line produced. Refused when it is not a row of the entity's cash flow statement.
|
|
8754
8772
|
*/
|
|
8755
8773
|
flow_qname?: string | null;
|
|
8756
8774
|
/**
|
|
@@ -9131,6 +9149,30 @@ export type LedgerEntityResponse = {
|
|
|
9131
9149
|
* The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
|
|
9132
9150
|
*/
|
|
9133
9151
|
ownership_pct?: number | null;
|
|
9152
|
+
/**
|
|
9153
|
+
* Consolidation Method
|
|
9154
|
+
*
|
|
9155
|
+
* How the group's consolidated statements treat this entity: `full` (its books are summed and an outside owner's share is carried as noncontrolling interest), `equity` (one investment line and one income line), `cost` (an investment at cost) or `none` (the group parent, the consolidation entity, a linked counterparty). Derived from `ownership_pct` when not given — 50 and above `full`, 20 to 50 `equity`, below 20 `cost`, unrecorded `full` — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method.
|
|
9156
|
+
*/
|
|
9157
|
+
consolidation_method?: string;
|
|
9158
|
+
/**
|
|
9159
|
+
* Entity Role
|
|
9160
|
+
*
|
|
9161
|
+
* `operating` keeps a company's books. `consolidation` is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is `none`.
|
|
9162
|
+
*/
|
|
9163
|
+
entity_role?: string;
|
|
9164
|
+
/**
|
|
9165
|
+
* Joined On
|
|
9166
|
+
*
|
|
9167
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. 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.
|
|
9168
|
+
*/
|
|
9169
|
+
joined_on?: string | null;
|
|
9170
|
+
/**
|
|
9171
|
+
* Left On
|
|
9172
|
+
*
|
|
9173
|
+
* 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.
|
|
9174
|
+
*/
|
|
9175
|
+
left_on?: string | null;
|
|
9134
9176
|
/**
|
|
9135
9177
|
* Source
|
|
9136
9178
|
*
|
|
@@ -9784,10 +9826,16 @@ export type LiveFinancialStatementRequest = {
|
|
|
9784
9826
|
* Fiscal year for annual window (anchored on FiscalCalendar)
|
|
9785
9827
|
*/
|
|
9786
9828
|
fiscal_year?: number | null;
|
|
9829
|
+
/**
|
|
9830
|
+
* Scope
|
|
9831
|
+
*
|
|
9832
|
+
* `entity` (the default): one entity's own books. `combined`: on the group parent, every member consolidated in full rendered under the parent's Reporting Style and summed per rs-gaap concept, each for the months it was a member — the pre-adjustment total, nothing eliminated. `consolidated`: the same sum plus the consolidation entity, whose eliminations and noncontrolling interest are the adjustments column, so a group that posts its consolidating entries there reads its consolidated statement. An equity-method or cost member is never summed (its `consolidation_method` says so). Both group scopes are read on the group parent only (422 on a subsidiary). An entity with no CoA mapping yet contributes nothing and is left out of `combined_entity_ids`.
|
|
9833
|
+
*/
|
|
9834
|
+
scope?: 'entity' | 'combined' | 'consolidated' | null;
|
|
9787
9835
|
/**
|
|
9788
9836
|
* Consolidated
|
|
9789
9837
|
*
|
|
9790
|
-
*
|
|
9838
|
+
* The older spelling of `scope: consolidated`, kept for callers that pass it; `scope` wins when both are given.
|
|
9791
9839
|
*/
|
|
9792
9840
|
consolidated?: boolean;
|
|
9793
9841
|
/**
|
|
@@ -9813,16 +9861,22 @@ export type LiveFinancialStatementResponse = {
|
|
|
9813
9861
|
* The entity whose books were rendered.
|
|
9814
9862
|
*/
|
|
9815
9863
|
entity_id?: string | null;
|
|
9864
|
+
/**
|
|
9865
|
+
* Scope
|
|
9866
|
+
*
|
|
9867
|
+
* What was rendered: `entity`, `combined` (the members summed, nothing eliminated) or `consolidated` (the members plus the consolidation entity's adjustments).
|
|
9868
|
+
*/
|
|
9869
|
+
scope?: string;
|
|
9816
9870
|
/**
|
|
9817
9871
|
* Consolidated
|
|
9818
9872
|
*
|
|
9819
|
-
* Whether the group's entities were summed into this
|
|
9873
|
+
* Whether the group's entities were summed into this — true for the `combined` and `consolidated` scopes.
|
|
9820
9874
|
*/
|
|
9821
9875
|
consolidated?: boolean;
|
|
9822
9876
|
/**
|
|
9823
9877
|
* Combined Entity Ids
|
|
9824
9878
|
*
|
|
9825
|
-
* The entities summed
|
|
9879
|
+
* The entities summed, parent first; on `consolidated` the consolidation entity comes last.
|
|
9826
9880
|
*/
|
|
9827
9881
|
combined_entity_ids?: Array<string>;
|
|
9828
9882
|
/**
|
|
@@ -9886,6 +9940,12 @@ export type LiveStatementFactRow = {
|
|
|
9886
9940
|
* Is Subtotal
|
|
9887
9941
|
*/
|
|
9888
9942
|
is_subtotal?: boolean;
|
|
9943
|
+
/**
|
|
9944
|
+
* Period Role
|
|
9945
|
+
*
|
|
9946
|
+
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
9947
|
+
*/
|
|
9948
|
+
period_role?: string | null;
|
|
9889
9949
|
};
|
|
9890
9950
|
/**
|
|
9891
9951
|
* LoginRequest
|
|
@@ -19269,6 +19329,12 @@ export type TaxonomyBlockStructureRequest = {
|
|
|
19269
19329
|
* `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
|
|
19270
19330
|
*/
|
|
19271
19331
|
target_framework?: string | null;
|
|
19332
|
+
/**
|
|
19333
|
+
* Extends Network
|
|
19334
|
+
*
|
|
19335
|
+
* `reporting_extension` only: the role URI of the Reporting Style network this structure extends (e.g. `https://robosystems.ai/seattle/cm-roles/roles/rs-gaap-presentation/CashFlow-indirect`). Its arcs then render as rows of that statement for every entity whose Style composes it. `block_type` must be that network's statement type. A row's parent must be on the network, a balance sheet, income statement or cash flow row needs a calculation arc from its section subtotal, an equity movement hangs from the roll-forward's root, and a tenant concept placed as a row must set `parent_ref` to the rs-gaap concept it refines — prefer the rs-gaap concept itself (any library concept may be named, including ones not yet in this graph).
|
|
19336
|
+
*/
|
|
19337
|
+
extends_network?: string | null;
|
|
19272
19338
|
/**
|
|
19273
19339
|
* Metadata
|
|
19274
19340
|
*/
|
|
@@ -19811,9 +19877,33 @@ export type UpdateEntityRequest = {
|
|
|
19811
19877
|
/**
|
|
19812
19878
|
* Ownership Pct
|
|
19813
19879
|
*
|
|
19814
|
-
* The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph.
|
|
19880
|
+
* The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph. A new share re-derives `consolidation_method` unless that is given too.
|
|
19815
19881
|
*/
|
|
19816
19882
|
ownership_pct?: number | null;
|
|
19883
|
+
/**
|
|
19884
|
+
* Consolidation Method
|
|
19885
|
+
*
|
|
19886
|
+
* How the group's consolidated statements treat this entity: `full` (its books are summed and an outside owner's share is carried as noncontrolling interest), `equity` (one investment line and one income line), `cost` (an investment at cost) or `none` (the group parent, the consolidation entity, a linked counterparty). Derived from `ownership_pct` when not given — 50 and above `full`, 20 to 50 `equity`, below 20 `cost`, unrecorded `full` — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method. On the group parent and the consolidation entity only `none` holds.
|
|
19887
|
+
*/
|
|
19888
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
19889
|
+
/**
|
|
19890
|
+
* Entity Role
|
|
19891
|
+
*
|
|
19892
|
+
* `operating` keeps a company's books. `consolidation` is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is `none`. Refused on the group parent. Marking an entity `consolidation` sets its method to `none`.
|
|
19893
|
+
*/
|
|
19894
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
19895
|
+
/**
|
|
19896
|
+
* Joined On
|
|
19897
|
+
*
|
|
19898
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. 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. Pass null to clear it.
|
|
19899
|
+
*/
|
|
19900
|
+
joined_on?: string | null;
|
|
19901
|
+
/**
|
|
19902
|
+
* Left On
|
|
19903
|
+
*
|
|
19904
|
+
* 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. Must not precede `joined_on`. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership.
|
|
19905
|
+
*/
|
|
19906
|
+
left_on?: string | null;
|
|
19817
19907
|
};
|
|
19818
19908
|
/**
|
|
19819
19909
|
* UpdateEventBlockRequest
|
package/types.gen.ts
CHANGED
|
@@ -2947,6 +2947,24 @@ export type CreateEntityRequest = {
|
|
|
2947
2947
|
* 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.
|
|
2948
2948
|
*/
|
|
2949
2949
|
ownership_pct?: number | null;
|
|
2950
|
+
/**
|
|
2951
|
+
* Consolidation Method
|
|
2952
|
+
*
|
|
2953
|
+
* How the group's consolidated statements treat this entity: `full` (its books are summed and an outside owner's share is carried as noncontrolling interest), `equity` (one investment line and one income line), `cost` (an investment at cost) or `none` (the group parent, the consolidation entity, a linked counterparty). Derived from `ownership_pct` when not given — 50 and above `full`, 20 to 50 `equity`, below 20 `cost`, unrecorded `full` — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method. Omit to derive it; a graph's first entity and a `consolidation` entity take `none`.
|
|
2954
|
+
*/
|
|
2955
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
2956
|
+
/**
|
|
2957
|
+
* Entity Role
|
|
2958
|
+
*
|
|
2959
|
+
* `operating` keeps a company's books. `consolidation` is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is `none`. Default `operating`; a graph's first entity, its group parent, is always operating. Start a consolidation entity's chart from the `consolidation` template.
|
|
2960
|
+
*/
|
|
2961
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
2962
|
+
/**
|
|
2963
|
+
* Joined On
|
|
2964
|
+
*
|
|
2965
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. 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. Omit for a subsidiary formed by the parent; give the acquisition month for one acquired, whose books in this graph then hold only what follows it.
|
|
2966
|
+
*/
|
|
2967
|
+
joined_on?: string | null;
|
|
2950
2968
|
/**
|
|
2951
2969
|
* Ticker
|
|
2952
2970
|
*
|
|
@@ -8537,9 +8555,9 @@ export type InitializeChartOfAccountsRequest = {
|
|
|
8537
8555
|
/**
|
|
8538
8556
|
* Template
|
|
8539
8557
|
*
|
|
8540
|
-
* Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue).
|
|
8558
|
+
* Template key: `saas` (subscription software — deferred revenue, cost of revenue, R&D / S&M / G&A), `services` (professional services — no inventory, no COGS), `product` (inventory and cost of goods sold, direct + wholesale + subscription revenue), `consolidation` (a group's consolidation entity: the eliminated investment, intercompany and subsidiary-equity rows, noncontrolling interest and its share of income — the adjustments column, never an operating company's chart).
|
|
8541
8559
|
*/
|
|
8542
|
-
template: 'saas' | 'services' | 'product';
|
|
8560
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8543
8561
|
/**
|
|
8544
8562
|
* Entity Type
|
|
8545
8563
|
*
|
|
@@ -8571,7 +8589,7 @@ export type InitializeChartOfAccountsResponse = {
|
|
|
8571
8589
|
/**
|
|
8572
8590
|
* Template
|
|
8573
8591
|
*/
|
|
8574
|
-
template: 'saas' | 'services' | 'product';
|
|
8592
|
+
template: 'saas' | 'services' | 'product' | 'consolidation';
|
|
8575
8593
|
/**
|
|
8576
8594
|
* Entity Type
|
|
8577
8595
|
*
|
|
@@ -8955,7 +8973,7 @@ export type JournalEntryLineItemInput = {
|
|
|
8955
8973
|
/**
|
|
8956
8974
|
* Flow Qname
|
|
8957
8975
|
*
|
|
8958
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. Refused when it is not a row of the entity's cash flow statement.
|
|
8976
|
+
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates(entityId)` lists the rows this company's statement offers). Only for a loan drawn or repaid, capital put in or taken out, an asset bought or sold; omitted, the account's default flow applies. A flow set on one side of the entry tags the untagged lines on the other: the cash flow statement reads the cash line and the roll-forwards read the account line. On the group's consolidation entity, which moves no cash, every tagged line counts on its own, cash-effect signed (a credit is an inflow), so an elimination offsets the flow a member's line produced. Refused when it is not a row of the entity's cash flow statement.
|
|
8959
8977
|
*/
|
|
8960
8978
|
flow_qname?: string | null;
|
|
8961
8979
|
/**
|
|
@@ -9342,6 +9360,30 @@ export type LedgerEntityResponse = {
|
|
|
9342
9360
|
* The parent's share of this entity, as a percent (100 = wholly owned). Null on the group parent, and where it was never recorded.
|
|
9343
9361
|
*/
|
|
9344
9362
|
ownership_pct?: number | null;
|
|
9363
|
+
/**
|
|
9364
|
+
* Consolidation Method
|
|
9365
|
+
*
|
|
9366
|
+
* How the group's consolidated statements treat this entity: `full` (its books are summed and an outside owner's share is carried as noncontrolling interest), `equity` (one investment line and one income line), `cost` (an investment at cost) or `none` (the group parent, the consolidation entity, a linked counterparty). Derived from `ownership_pct` when not given — 50 and above `full`, 20 to 50 `equity`, below 20 `cost`, unrecorded `full` — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method.
|
|
9367
|
+
*/
|
|
9368
|
+
consolidation_method?: string;
|
|
9369
|
+
/**
|
|
9370
|
+
* Entity Role
|
|
9371
|
+
*
|
|
9372
|
+
* `operating` keeps a company's books. `consolidation` is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is `none`.
|
|
9373
|
+
*/
|
|
9374
|
+
entity_role?: string;
|
|
9375
|
+
/**
|
|
9376
|
+
* Joined On
|
|
9377
|
+
*
|
|
9378
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. 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.
|
|
9379
|
+
*/
|
|
9380
|
+
joined_on?: string | null;
|
|
9381
|
+
/**
|
|
9382
|
+
* Left On
|
|
9383
|
+
*
|
|
9384
|
+
* 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.
|
|
9385
|
+
*/
|
|
9386
|
+
left_on?: string | null;
|
|
9345
9387
|
/**
|
|
9346
9388
|
* Source
|
|
9347
9389
|
*
|
|
@@ -10008,10 +10050,16 @@ export type LiveFinancialStatementRequest = {
|
|
|
10008
10050
|
* Fiscal year for annual window (anchored on FiscalCalendar)
|
|
10009
10051
|
*/
|
|
10010
10052
|
fiscal_year?: number | null;
|
|
10053
|
+
/**
|
|
10054
|
+
* Scope
|
|
10055
|
+
*
|
|
10056
|
+
* `entity` (the default): one entity's own books. `combined`: on the group parent, every member consolidated in full rendered under the parent's Reporting Style and summed per rs-gaap concept, each for the months it was a member — the pre-adjustment total, nothing eliminated. `consolidated`: the same sum plus the consolidation entity, whose eliminations and noncontrolling interest are the adjustments column, so a group that posts its consolidating entries there reads its consolidated statement. An equity-method or cost member is never summed (its `consolidation_method` says so). Both group scopes are read on the group parent only (422 on a subsidiary). An entity with no CoA mapping yet contributes nothing and is left out of `combined_entity_ids`.
|
|
10057
|
+
*/
|
|
10058
|
+
scope?: 'entity' | 'combined' | 'consolidated' | null;
|
|
10011
10059
|
/**
|
|
10012
10060
|
* Consolidated
|
|
10013
10061
|
*
|
|
10014
|
-
*
|
|
10062
|
+
* The older spelling of `scope: consolidated`, kept for callers that pass it; `scope` wins when both are given.
|
|
10015
10063
|
*/
|
|
10016
10064
|
consolidated?: boolean;
|
|
10017
10065
|
/**
|
|
@@ -10038,16 +10086,22 @@ export type LiveFinancialStatementResponse = {
|
|
|
10038
10086
|
* The entity whose books were rendered.
|
|
10039
10087
|
*/
|
|
10040
10088
|
entity_id?: string | null;
|
|
10089
|
+
/**
|
|
10090
|
+
* Scope
|
|
10091
|
+
*
|
|
10092
|
+
* What was rendered: `entity`, `combined` (the members summed, nothing eliminated) or `consolidated` (the members plus the consolidation entity's adjustments).
|
|
10093
|
+
*/
|
|
10094
|
+
scope?: string;
|
|
10041
10095
|
/**
|
|
10042
10096
|
* Consolidated
|
|
10043
10097
|
*
|
|
10044
|
-
* Whether the group's entities were summed into this
|
|
10098
|
+
* Whether the group's entities were summed into this — true for the `combined` and `consolidated` scopes.
|
|
10045
10099
|
*/
|
|
10046
10100
|
consolidated?: boolean;
|
|
10047
10101
|
/**
|
|
10048
10102
|
* Combined Entity Ids
|
|
10049
10103
|
*
|
|
10050
|
-
* The entities summed
|
|
10104
|
+
* The entities summed, parent first; on `consolidated` the consolidation entity comes last.
|
|
10051
10105
|
*/
|
|
10052
10106
|
combined_entity_ids?: Array<string>;
|
|
10053
10107
|
/**
|
|
@@ -10112,6 +10166,12 @@ export type LiveStatementFactRow = {
|
|
|
10112
10166
|
* Is Subtotal
|
|
10113
10167
|
*/
|
|
10114
10168
|
is_subtotal?: boolean;
|
|
10169
|
+
/**
|
|
10170
|
+
* Period Role
|
|
10171
|
+
*
|
|
10172
|
+
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10173
|
+
*/
|
|
10174
|
+
period_role?: string | null;
|
|
10115
10175
|
};
|
|
10116
10176
|
|
|
10117
10177
|
/**
|
|
@@ -19727,6 +19787,12 @@ export type TaxonomyBlockStructureRequest = {
|
|
|
19727
19787
|
* `coa_mapping` only: the framework this mapping maps the chart into, e.g. `rs-gaap`. Omitted means the graph's book framework. A chart holds one mapping per framework.
|
|
19728
19788
|
*/
|
|
19729
19789
|
target_framework?: string | null;
|
|
19790
|
+
/**
|
|
19791
|
+
* Extends Network
|
|
19792
|
+
*
|
|
19793
|
+
* `reporting_extension` only: the role URI of the Reporting Style network this structure extends (e.g. `https://robosystems.ai/seattle/cm-roles/roles/rs-gaap-presentation/CashFlow-indirect`). Its arcs then render as rows of that statement for every entity whose Style composes it. `block_type` must be that network's statement type. A row's parent must be on the network, a balance sheet, income statement or cash flow row needs a calculation arc from its section subtotal, an equity movement hangs from the roll-forward's root, and a tenant concept placed as a row must set `parent_ref` to the rs-gaap concept it refines — prefer the rs-gaap concept itself (any library concept may be named, including ones not yet in this graph).
|
|
19794
|
+
*/
|
|
19795
|
+
extends_network?: string | null;
|
|
19730
19796
|
/**
|
|
19731
19797
|
* Metadata
|
|
19732
19798
|
*/
|
|
@@ -20285,9 +20351,33 @@ export type UpdateEntityRequest = {
|
|
|
20285
20351
|
/**
|
|
20286
20352
|
* Ownership Pct
|
|
20287
20353
|
*
|
|
20288
|
-
* The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph.
|
|
20354
|
+
* The parent's share of this entity, as a percent. Refused on the group parent, which has no owner in the graph. A new share re-derives `consolidation_method` unless that is given too.
|
|
20289
20355
|
*/
|
|
20290
20356
|
ownership_pct?: number | null;
|
|
20357
|
+
/**
|
|
20358
|
+
* Consolidation Method
|
|
20359
|
+
*
|
|
20360
|
+
* How the group's consolidated statements treat this entity: `full` (its books are summed and an outside owner's share is carried as noncontrolling interest), `equity` (one investment line and one income line), `cost` (an investment at cost) or `none` (the group parent, the consolidation entity, a linked counterparty). Derived from `ownership_pct` when not given — 50 and above `full`, 20 to 50 `equity`, below 20 `cost`, unrecorded `full` — and set by a person where control is not the percentage: a managing member with a minority stake consolidates in full, a majority without control takes the equity method. On the group parent and the consolidation entity only `none` holds.
|
|
20361
|
+
*/
|
|
20362
|
+
consolidation_method?: 'full' | 'equity' | 'cost' | 'none' | null;
|
|
20363
|
+
/**
|
|
20364
|
+
* Entity Role
|
|
20365
|
+
*
|
|
20366
|
+
* `operating` keeps a company's books. `consolidation` is the group's one entity for the consolidating entries — eliminations, noncontrolling interest, the equity-method pick-up — the adjustments column of a consolidation worksheet, which only the consolidated statements read and no operating company's statements ever include. Its method is `none`. Refused on the group parent. Marking an entity `consolidation` sets its method to `none`.
|
|
20367
|
+
*/
|
|
20368
|
+
entity_role?: 'operating' | 'consolidation' | null;
|
|
20369
|
+
/**
|
|
20370
|
+
* Joined On
|
|
20371
|
+
*
|
|
20372
|
+
* The month this entity became a member of the group, as any date in it; null is a member since the beginning. The consolidated statements include it from that month. 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. Pass null to clear it.
|
|
20373
|
+
*/
|
|
20374
|
+
joined_on?: string | null;
|
|
20375
|
+
/**
|
|
20376
|
+
* Left On
|
|
20377
|
+
*
|
|
20378
|
+
* 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. Must not precede `joined_on`. Set it when a subsidiary is sold, dissolved or deconsolidated; its closed months and stamped statements stay readable under the group. Pass null to reopen membership.
|
|
20379
|
+
*/
|
|
20380
|
+
left_on?: string | null;
|
|
20291
20381
|
};
|
|
20292
20382
|
|
|
20293
20383
|
/**
|