@robosystems/client 2.23.0 → 2.25.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 +22 -1
- package/artifacts/LedgerClient.js +21 -0
- package/artifacts/LedgerClient.ts +44 -0
- package/artifacts/graphql/generated/graphql.d.ts +147 -0
- package/artifacts/graphql/generated/graphql.js +322 -2
- package/artifacts/graphql/generated/graphql.ts +456 -0
- package/artifacts/graphql/queries/ledger/accountRegister.d.ts +13 -0
- package/artifacts/graphql/queries/ledger/accountRegister.js +98 -0
- package/artifacts/graphql/queries/ledger/accountRegister.ts +96 -0
- package/artifacts/graphql/queries/ledger/eventBlock.d.ts +3 -1
- package/artifacts/graphql/queries/ledger/eventBlock.js +24 -1
- package/artifacts/graphql/queries/ledger/eventBlock.ts +24 -1
- package/artifacts/graphql/queries/ledger/informationBlock.js +6 -0
- package/artifacts/graphql/queries/ledger/informationBlock.ts +6 -0
- package/artifacts/graphql/queries/ledger/journalEntries.js +1 -0
- package/artifacts/graphql/queries/ledger/journalEntries.ts +1 -0
- package/artifacts/graphql/queries/ledger/reportPackage.js +2 -0
- package/artifacts/graphql/queries/ledger/reportPackage.ts +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/sdk/index.d.ts +1 -1
- package/sdk/index.ts +1 -1
- package/sdk/sdk.gen.d.ts +2 -2
- package/sdk/sdk.gen.js +2 -2
- package/sdk/sdk.gen.ts +2 -2
- package/sdk/types.gen.d.ts +70 -0
- package/sdk/types.gen.ts +71 -0
- package/sdk.gen.d.ts +2 -2
- package/sdk.gen.js +2 -2
- package/sdk.gen.ts +2 -2
- package/types.gen.d.ts +70 -0
- package/types.gen.ts +71 -0
package/sdk/types.gen.ts
CHANGED
|
@@ -6834,6 +6834,20 @@ export type FactLite = {
|
|
|
6834
6834
|
* Fact Set Id
|
|
6835
6835
|
*/
|
|
6836
6836
|
fact_set_id?: string | null;
|
|
6837
|
+
/**
|
|
6838
|
+
* Provenance
|
|
6839
|
+
*
|
|
6840
|
+
* The fact's own typed `FactProvenance` descriptor (discriminated on `origin`): a `pivot` names the accounts that foot to it, a `rollup` the concepts and weights it summed, a `derived` value its computations and the amounts by part. Null means unknown, never the set's descriptor.
|
|
6841
|
+
*/
|
|
6842
|
+
provenance?: {
|
|
6843
|
+
[key: string]: unknown;
|
|
6844
|
+
} | null;
|
|
6845
|
+
/**
|
|
6846
|
+
* Frozen At
|
|
6847
|
+
*
|
|
6848
|
+
* When the fact's column froze: its period fully closed, so the value is the record. Null is a live column that follows the books.
|
|
6849
|
+
*/
|
|
6850
|
+
frozen_at?: string | null;
|
|
6837
6851
|
};
|
|
6838
6852
|
|
|
6839
6853
|
/**
|
|
@@ -10572,6 +10586,12 @@ export type LiveFinancialStatementRequest = {
|
|
|
10572
10586
|
* Slice an income statement by a management dimension (department, class, location, project). `{type, member_id}` reads one member's lines, current and prior; `member_id: unallocated` reads the lines no member of the axis tags. `{type}` alone reads the current window with one column per member, then Unallocated, then Total, and says in `dimension.ties_out` whether every row's members plus Unallocated equal its Total. Composes with `scope` and `entity_id`; a consolidation entity's lines are untagged, so eliminations read as Unallocated. Refused (422) on any other statement.
|
|
10573
10587
|
*/
|
|
10574
10588
|
dimension?: StatementDimension | null;
|
|
10589
|
+
/**
|
|
10590
|
+
* Include Sources
|
|
10591
|
+
*
|
|
10592
|
+
* Add each row's `origin` and, per column, the accounts its figure was summed from (`sources`), each keyed by the entity whose books hold it, so a figure opens on the account registers behind it. Consolidated figures list each member's accounts and the consolidation entity's. Off by default: it multiplies the response. Refused (422) with a `dimension` read by column.
|
|
10593
|
+
*/
|
|
10594
|
+
include_sources?: boolean;
|
|
10575
10595
|
};
|
|
10576
10596
|
|
|
10577
10597
|
/**
|
|
@@ -10686,6 +10706,18 @@ export type LiveStatementFactRow = {
|
|
|
10686
10706
|
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10687
10707
|
*/
|
|
10688
10708
|
period_role?: string | null;
|
|
10709
|
+
/**
|
|
10710
|
+
* Origin
|
|
10711
|
+
*
|
|
10712
|
+
* With `include_sources`, how the figure was made: `accounts` (summed from accounts in at least one column; read each column's `sources`, which may be empty where they do not add up), `subtotal` (the rows beneath it), or `computed` (derived from other figures, or a flow, with no accounts of its own). Null without `include_sources`.
|
|
10713
|
+
*/
|
|
10714
|
+
origin?: 'accounts' | 'subtotal' | 'computed' | null;
|
|
10715
|
+
/**
|
|
10716
|
+
* Sources
|
|
10717
|
+
*
|
|
10718
|
+
* With `include_sources`, per column (aligned with `values`), the accounts the figure was summed from, largest first; their values add up to the figure. Empty for a column with nothing to show, and for a subtotal or computed row.
|
|
10719
|
+
*/
|
|
10720
|
+
sources?: Array<Array<StatementRowSource>> | null;
|
|
10689
10721
|
};
|
|
10690
10722
|
|
|
10691
10723
|
/**
|
|
@@ -19852,6 +19884,45 @@ export type StatementMechanics = {
|
|
|
19852
19884
|
period_comparisons?: number;
|
|
19853
19885
|
};
|
|
19854
19886
|
|
|
19887
|
+
/**
|
|
19888
|
+
* StatementRowSource
|
|
19889
|
+
*
|
|
19890
|
+
* One account's part in a statement figure: what that account, in that
|
|
19891
|
+
* entity's books, contributed to the column.
|
|
19892
|
+
*/
|
|
19893
|
+
export type StatementRowSource = {
|
|
19894
|
+
/**
|
|
19895
|
+
* Entity Id
|
|
19896
|
+
*
|
|
19897
|
+
* The entity whose books hold the lines, the register to open.
|
|
19898
|
+
*/
|
|
19899
|
+
entity_id: string;
|
|
19900
|
+
/**
|
|
19901
|
+
* Account Id
|
|
19902
|
+
*
|
|
19903
|
+
* The account.
|
|
19904
|
+
*/
|
|
19905
|
+
account_id: string;
|
|
19906
|
+
/**
|
|
19907
|
+
* Code
|
|
19908
|
+
*
|
|
19909
|
+
* The account's code.
|
|
19910
|
+
*/
|
|
19911
|
+
code?: string | null;
|
|
19912
|
+
/**
|
|
19913
|
+
* Name
|
|
19914
|
+
*
|
|
19915
|
+
* The account's name.
|
|
19916
|
+
*/
|
|
19917
|
+
name: string;
|
|
19918
|
+
/**
|
|
19919
|
+
* Value
|
|
19920
|
+
*
|
|
19921
|
+
* What the account contributed, in the figure's sign.
|
|
19922
|
+
*/
|
|
19923
|
+
value: number;
|
|
19924
|
+
};
|
|
19925
|
+
|
|
19855
19926
|
/**
|
|
19856
19927
|
* StorageItem
|
|
19857
19928
|
*
|
package/sdk.gen.d.ts
CHANGED
|
@@ -1278,7 +1278,7 @@ export declare const createReport: <ThrowOnError extends boolean = false>(option
|
|
|
1278
1278
|
/**
|
|
1279
1279
|
* Regenerate Report
|
|
1280
1280
|
*
|
|
1281
|
-
*
|
|
1281
|
+
* Rewrites a Report's live columns from the latest ledger state. A column whose period the books have closed is frozen and keeps its facts; an open column already follows the ledger on every read, so pass `period_start`/`period_end`/`periods` to change the reporting window, which drops the frozen facts of any window no column states.
|
|
1282
1282
|
*
|
|
1283
1283
|
* **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.
|
|
1284
1284
|
*/
|
|
@@ -1294,7 +1294,7 @@ export declare const deleteReport: <ThrowOnError extends boolean = false>(option
|
|
|
1294
1294
|
/**
|
|
1295
1295
|
* File Report
|
|
1296
1296
|
*
|
|
1297
|
-
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by.
|
|
1297
|
+
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review', and only once the books are closed through every period the Report states. Stamps filed_at + filed_by.
|
|
1298
1298
|
*
|
|
1299
1299
|
* **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.
|
|
1300
1300
|
*/
|
package/sdk.gen.js
CHANGED
|
@@ -2640,7 +2640,7 @@ exports.createReport = createReport;
|
|
|
2640
2640
|
/**
|
|
2641
2641
|
* Regenerate Report
|
|
2642
2642
|
*
|
|
2643
|
-
*
|
|
2643
|
+
* Rewrites a Report's live columns from the latest ledger state. A column whose period the books have closed is frozen and keeps its facts; an open column already follows the ledger on every read, so pass `period_start`/`period_end`/`periods` to change the reporting window, which drops the frozen facts of any window no column states.
|
|
2644
2644
|
*
|
|
2645
2645
|
* **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.
|
|
2646
2646
|
*/
|
|
@@ -2674,7 +2674,7 @@ exports.deleteReport = deleteReport;
|
|
|
2674
2674
|
/**
|
|
2675
2675
|
* File Report
|
|
2676
2676
|
*
|
|
2677
|
-
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by.
|
|
2677
|
+
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review', and only once the books are closed through every period the Report states. Stamps filed_at + filed_by.
|
|
2678
2678
|
*
|
|
2679
2679
|
* **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.
|
|
2680
2680
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -2651,7 +2651,7 @@ export const createReport = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
2651
2651
|
/**
|
|
2652
2652
|
* Regenerate Report
|
|
2653
2653
|
*
|
|
2654
|
-
*
|
|
2654
|
+
* Rewrites a Report's live columns from the latest ledger state. A column whose period the books have closed is frozen and keeps its facts; an open column already follows the ledger on every read, so pass `period_start`/`period_end`/`periods` to change the reporting window, which drops the frozen facts of any window no column states.
|
|
2655
2655
|
*
|
|
2656
2656
|
* **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.
|
|
2657
2657
|
*/
|
|
@@ -2685,7 +2685,7 @@ export const deleteReport = <ThrowOnError extends boolean = false>(options: Opti
|
|
|
2685
2685
|
/**
|
|
2686
2686
|
* File Report
|
|
2687
2687
|
*
|
|
2688
|
-
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review'. Stamps filed_at + filed_by.
|
|
2688
|
+
* Transitions the Report's filing_status to 'filed' — locks the package. Allowed from 'draft' or 'under_review', and only once the books are closed through every period the Report states. Stamps filed_at + filed_by.
|
|
2689
2689
|
*
|
|
2690
2690
|
* **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.
|
|
2691
2691
|
*/
|
package/types.gen.d.ts
CHANGED
|
@@ -6673,6 +6673,20 @@ export type FactLite = {
|
|
|
6673
6673
|
* Fact Set Id
|
|
6674
6674
|
*/
|
|
6675
6675
|
fact_set_id?: string | null;
|
|
6676
|
+
/**
|
|
6677
|
+
* Provenance
|
|
6678
|
+
*
|
|
6679
|
+
* The fact's own typed `FactProvenance` descriptor (discriminated on `origin`): a `pivot` names the accounts that foot to it, a `rollup` the concepts and weights it summed, a `derived` value its computations and the amounts by part. Null means unknown, never the set's descriptor.
|
|
6680
|
+
*/
|
|
6681
|
+
provenance?: {
|
|
6682
|
+
[key: string]: unknown;
|
|
6683
|
+
} | null;
|
|
6684
|
+
/**
|
|
6685
|
+
* Frozen At
|
|
6686
|
+
*
|
|
6687
|
+
* When the fact's column froze: its period fully closed, so the value is the record. Null is a live column that follows the books.
|
|
6688
|
+
*/
|
|
6689
|
+
frozen_at?: string | null;
|
|
6676
6690
|
};
|
|
6677
6691
|
/**
|
|
6678
6692
|
* FactRecord
|
|
@@ -10337,6 +10351,12 @@ export type LiveFinancialStatementRequest = {
|
|
|
10337
10351
|
* Slice an income statement by a management dimension (department, class, location, project). `{type, member_id}` reads one member's lines, current and prior; `member_id: unallocated` reads the lines no member of the axis tags. `{type}` alone reads the current window with one column per member, then Unallocated, then Total, and says in `dimension.ties_out` whether every row's members plus Unallocated equal its Total. Composes with `scope` and `entity_id`; a consolidation entity's lines are untagged, so eliminations read as Unallocated. Refused (422) on any other statement.
|
|
10338
10352
|
*/
|
|
10339
10353
|
dimension?: StatementDimension | null;
|
|
10354
|
+
/**
|
|
10355
|
+
* Include Sources
|
|
10356
|
+
*
|
|
10357
|
+
* Add each row's `origin` and, per column, the accounts its figure was summed from (`sources`), each keyed by the entity whose books hold it, so a figure opens on the account registers behind it. Consolidated figures list each member's accounts and the consolidation entity's. Off by default: it multiplies the response. Refused (422) with a `dimension` read by column.
|
|
10358
|
+
*/
|
|
10359
|
+
include_sources?: boolean;
|
|
10340
10360
|
};
|
|
10341
10361
|
/**
|
|
10342
10362
|
* LiveFinancialStatementResponse
|
|
@@ -10449,6 +10469,18 @@ export type LiveStatementFactRow = {
|
|
|
10449
10469
|
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10450
10470
|
*/
|
|
10451
10471
|
period_role?: string | null;
|
|
10472
|
+
/**
|
|
10473
|
+
* Origin
|
|
10474
|
+
*
|
|
10475
|
+
* With `include_sources`, how the figure was made: `accounts` (summed from accounts in at least one column; read each column's `sources`, which may be empty where they do not add up), `subtotal` (the rows beneath it), or `computed` (derived from other figures, or a flow, with no accounts of its own). Null without `include_sources`.
|
|
10476
|
+
*/
|
|
10477
|
+
origin?: 'accounts' | 'subtotal' | 'computed' | null;
|
|
10478
|
+
/**
|
|
10479
|
+
* Sources
|
|
10480
|
+
*
|
|
10481
|
+
* With `include_sources`, per column (aligned with `values`), the accounts the figure was summed from, largest first; their values add up to the figure. Empty for a column with nothing to show, and for a subtotal or computed row.
|
|
10482
|
+
*/
|
|
10483
|
+
sources?: Array<Array<StatementRowSource>> | null;
|
|
10452
10484
|
};
|
|
10453
10485
|
/**
|
|
10454
10486
|
* LoginRequest
|
|
@@ -19389,6 +19421,44 @@ export type StatementMechanics = {
|
|
|
19389
19421
|
*/
|
|
19390
19422
|
period_comparisons?: number;
|
|
19391
19423
|
};
|
|
19424
|
+
/**
|
|
19425
|
+
* StatementRowSource
|
|
19426
|
+
*
|
|
19427
|
+
* One account's part in a statement figure: what that account, in that
|
|
19428
|
+
* entity's books, contributed to the column.
|
|
19429
|
+
*/
|
|
19430
|
+
export type StatementRowSource = {
|
|
19431
|
+
/**
|
|
19432
|
+
* Entity Id
|
|
19433
|
+
*
|
|
19434
|
+
* The entity whose books hold the lines, the register to open.
|
|
19435
|
+
*/
|
|
19436
|
+
entity_id: string;
|
|
19437
|
+
/**
|
|
19438
|
+
* Account Id
|
|
19439
|
+
*
|
|
19440
|
+
* The account.
|
|
19441
|
+
*/
|
|
19442
|
+
account_id: string;
|
|
19443
|
+
/**
|
|
19444
|
+
* Code
|
|
19445
|
+
*
|
|
19446
|
+
* The account's code.
|
|
19447
|
+
*/
|
|
19448
|
+
code?: string | null;
|
|
19449
|
+
/**
|
|
19450
|
+
* Name
|
|
19451
|
+
*
|
|
19452
|
+
* The account's name.
|
|
19453
|
+
*/
|
|
19454
|
+
name: string;
|
|
19455
|
+
/**
|
|
19456
|
+
* Value
|
|
19457
|
+
*
|
|
19458
|
+
* What the account contributed, in the figure's sign.
|
|
19459
|
+
*/
|
|
19460
|
+
value: number;
|
|
19461
|
+
};
|
|
19392
19462
|
/**
|
|
19393
19463
|
* StorageItem
|
|
19394
19464
|
*
|
package/types.gen.ts
CHANGED
|
@@ -6834,6 +6834,20 @@ export type FactLite = {
|
|
|
6834
6834
|
* Fact Set Id
|
|
6835
6835
|
*/
|
|
6836
6836
|
fact_set_id?: string | null;
|
|
6837
|
+
/**
|
|
6838
|
+
* Provenance
|
|
6839
|
+
*
|
|
6840
|
+
* The fact's own typed `FactProvenance` descriptor (discriminated on `origin`): a `pivot` names the accounts that foot to it, a `rollup` the concepts and weights it summed, a `derived` value its computations and the amounts by part. Null means unknown, never the set's descriptor.
|
|
6841
|
+
*/
|
|
6842
|
+
provenance?: {
|
|
6843
|
+
[key: string]: unknown;
|
|
6844
|
+
} | null;
|
|
6845
|
+
/**
|
|
6846
|
+
* Frozen At
|
|
6847
|
+
*
|
|
6848
|
+
* When the fact's column froze: its period fully closed, so the value is the record. Null is a live column that follows the books.
|
|
6849
|
+
*/
|
|
6850
|
+
frozen_at?: string | null;
|
|
6837
6851
|
};
|
|
6838
6852
|
|
|
6839
6853
|
/**
|
|
@@ -10572,6 +10586,12 @@ export type LiveFinancialStatementRequest = {
|
|
|
10572
10586
|
* Slice an income statement by a management dimension (department, class, location, project). `{type, member_id}` reads one member's lines, current and prior; `member_id: unallocated` reads the lines no member of the axis tags. `{type}` alone reads the current window with one column per member, then Unallocated, then Total, and says in `dimension.ties_out` whether every row's members plus Unallocated equal its Total. Composes with `scope` and `entity_id`; a consolidation entity's lines are untagged, so eliminations read as Unallocated. Refused (422) on any other statement.
|
|
10573
10587
|
*/
|
|
10574
10588
|
dimension?: StatementDimension | null;
|
|
10589
|
+
/**
|
|
10590
|
+
* Include Sources
|
|
10591
|
+
*
|
|
10592
|
+
* Add each row's `origin` and, per column, the accounts its figure was summed from (`sources`), each keyed by the entity whose books hold it, so a figure opens on the account registers behind it. Consolidated figures list each member's accounts and the consolidation entity's. Off by default: it multiplies the response. Refused (422) with a `dimension` read by column.
|
|
10593
|
+
*/
|
|
10594
|
+
include_sources?: boolean;
|
|
10575
10595
|
};
|
|
10576
10596
|
|
|
10577
10597
|
/**
|
|
@@ -10686,6 +10706,18 @@ export type LiveStatementFactRow = {
|
|
|
10686
10706
|
* On the equity roll-forward, `start` for the beginning-balance row and `end` for the ending-balance row. Null elsewhere.
|
|
10687
10707
|
*/
|
|
10688
10708
|
period_role?: string | null;
|
|
10709
|
+
/**
|
|
10710
|
+
* Origin
|
|
10711
|
+
*
|
|
10712
|
+
* With `include_sources`, how the figure was made: `accounts` (summed from accounts in at least one column; read each column's `sources`, which may be empty where they do not add up), `subtotal` (the rows beneath it), or `computed` (derived from other figures, or a flow, with no accounts of its own). Null without `include_sources`.
|
|
10713
|
+
*/
|
|
10714
|
+
origin?: 'accounts' | 'subtotal' | 'computed' | null;
|
|
10715
|
+
/**
|
|
10716
|
+
* Sources
|
|
10717
|
+
*
|
|
10718
|
+
* With `include_sources`, per column (aligned with `values`), the accounts the figure was summed from, largest first; their values add up to the figure. Empty for a column with nothing to show, and for a subtotal or computed row.
|
|
10719
|
+
*/
|
|
10720
|
+
sources?: Array<Array<StatementRowSource>> | null;
|
|
10689
10721
|
};
|
|
10690
10722
|
|
|
10691
10723
|
/**
|
|
@@ -19852,6 +19884,45 @@ export type StatementMechanics = {
|
|
|
19852
19884
|
period_comparisons?: number;
|
|
19853
19885
|
};
|
|
19854
19886
|
|
|
19887
|
+
/**
|
|
19888
|
+
* StatementRowSource
|
|
19889
|
+
*
|
|
19890
|
+
* One account's part in a statement figure: what that account, in that
|
|
19891
|
+
* entity's books, contributed to the column.
|
|
19892
|
+
*/
|
|
19893
|
+
export type StatementRowSource = {
|
|
19894
|
+
/**
|
|
19895
|
+
* Entity Id
|
|
19896
|
+
*
|
|
19897
|
+
* The entity whose books hold the lines, the register to open.
|
|
19898
|
+
*/
|
|
19899
|
+
entity_id: string;
|
|
19900
|
+
/**
|
|
19901
|
+
* Account Id
|
|
19902
|
+
*
|
|
19903
|
+
* The account.
|
|
19904
|
+
*/
|
|
19905
|
+
account_id: string;
|
|
19906
|
+
/**
|
|
19907
|
+
* Code
|
|
19908
|
+
*
|
|
19909
|
+
* The account's code.
|
|
19910
|
+
*/
|
|
19911
|
+
code?: string | null;
|
|
19912
|
+
/**
|
|
19913
|
+
* Name
|
|
19914
|
+
*
|
|
19915
|
+
* The account's name.
|
|
19916
|
+
*/
|
|
19917
|
+
name: string;
|
|
19918
|
+
/**
|
|
19919
|
+
* Value
|
|
19920
|
+
*
|
|
19921
|
+
* What the account contributed, in the figure's sign.
|
|
19922
|
+
*/
|
|
19923
|
+
value: number;
|
|
19924
|
+
};
|
|
19925
|
+
|
|
19855
19926
|
/**
|
|
19856
19927
|
* StorageItem
|
|
19857
19928
|
*
|