@robosystems/client 2.38.1 → 2.39.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/InvestorClient.d.ts +4 -2
- package/artifacts/InvestorClient.js +4 -2
- package/artifacts/InvestorClient.ts +4 -2
- package/artifacts/LedgerClient.d.ts +31 -23
- package/artifacts/LedgerClient.js +27 -19
- package/artifacts/LedgerClient.ts +34 -26
- package/artifacts/LibraryClient.d.ts +4 -4
- package/artifacts/LibraryClient.js +4 -4
- package/artifacts/LibraryClient.ts +5 -5
- package/artifacts/OperatorClient.d.ts +2 -2
- package/artifacts/OperatorClient.js +2 -2
- package/artifacts/OperatorClient.ts +2 -2
- package/artifacts/graphql/queries/ledger/flowCandidates.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/flowCandidates.js +1 -1
- package/artifacts/graphql/queries/ledger/flowCandidates.ts +1 -1
- package/artifacts/graphql/queries/ledger/informationBlock.d.ts +3 -5
- package/artifacts/graphql/queries/ledger/informationBlock.js +3 -5
- package/artifacts/graphql/queries/ledger/informationBlock.ts +3 -5
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.js +1 -1
- package/artifacts/graphql/queries/ledger/mappedTrialBalance.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.js +1 -1
- package/artifacts/graphql/queries/ledger/mappingCoverage.ts +1 -1
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.d.ts +3 -2
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.js +3 -2
- package/artifacts/graphql/queries/ledger/reportDownloadUrl.ts +3 -2
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.d.ts +3 -3
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.js +3 -3
- package/artifacts/graphql/queries/ledger/reportingTaxonomy.ts +3 -3
- package/artifacts/graphql/queries/ledger/statement.d.ts +5 -4
- package/artifacts/graphql/queries/ledger/statement.js +5 -4
- package/artifacts/graphql/queries/ledger/statement.ts +5 -4
- package/artifacts/graphql/queries/ledger/structures.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/structures.js +1 -1
- package/artifacts/graphql/queries/ledger/structures.ts +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.d.ts +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.js +1 -1
- package/artifacts/graphql/queries/ledger/unmappedElements.ts +1 -1
- package/artifacts/graphql/queries/library/arcs.d.ts +1 -1
- package/artifacts/graphql/queries/library/arcs.js +1 -1
- package/artifacts/graphql/queries/library/arcs.ts +1 -1
- package/artifacts/graphql/queries/library/elements.d.ts +1 -1
- package/artifacts/graphql/queries/library/elements.js +1 -1
- package/artifacts/graphql/queries/library/elements.ts +1 -1
- package/artifacts/hooks.d.ts +8 -8
- package/artifacts/hooks.js +8 -8
- package/artifacts/hooks.ts +8 -8
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +13 -13
- package/sdk/sdk.gen.js +13 -13
- package/sdk/sdk.gen.ts +13 -13
- package/sdk/types.gen.d.ts +76 -67
- package/sdk/types.gen.ts +76 -67
- package/sdk.gen.d.ts +13 -13
- package/sdk.gen.js +13 -13
- package/sdk.gen.ts +13 -13
- package/types.gen.d.ts +76 -67
- package/types.gen.ts +76 -67
package/sdk/types.gen.ts
CHANGED
|
@@ -389,7 +389,7 @@ export type AddPublishListMembersOperation = {
|
|
|
389
389
|
/**
|
|
390
390
|
* Target Graph Ids
|
|
391
391
|
*
|
|
392
|
-
* Graph IDs to add. Each must exist and
|
|
392
|
+
* Graph IDs to add. Each must exist and carry the roboledger or roboinvestor extension. Self-graph rejected.
|
|
393
393
|
*/
|
|
394
394
|
target_graph_ids: Array<string>;
|
|
395
395
|
/**
|
|
@@ -2195,14 +2195,18 @@ export type CompleteDocumentUploadOp = {
|
|
|
2195
2195
|
*
|
|
2196
2196
|
* Request body for the `compute-forecast` operation.
|
|
2197
2197
|
*
|
|
2198
|
-
* Walks the scenario's driver cascade month-by-month forward from
|
|
2199
|
-
*
|
|
2200
|
-
*
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2203
|
-
*
|
|
2204
|
-
*
|
|
2205
|
-
*
|
|
2198
|
+
* Walks the scenario's driver cascade month-by-month forward from its
|
|
2199
|
+
* anchor — the newest closed month inside the horizon under
|
|
2200
|
+
* `base_anchor='seam'` (the default), the block's `base_period` under
|
|
2201
|
+
* `'fixed'`: lever-driven Derive rules in dependency order, carry-forward
|
|
2202
|
+
* for unmodeled IS lines, calc-DAG subtotals — upserting per forward
|
|
2203
|
+
* month a scenario IS FactSet, a BS set (the full roll when the anchor
|
|
2204
|
+
* month has an actual balance sheet, else the rule-driven working-capital
|
|
2205
|
+
* instants) and a derived CF set when an actual one exists, all keyed by
|
|
2206
|
+
* the forecast block's `scenario_id`. Re-running replaces each month's
|
|
2207
|
+
* values (the compute-metrics drift semantics). A month that fails
|
|
2208
|
+
* verification halts the walk (`halted_at`). Deterministic and non-AI —
|
|
2209
|
+
* no credits consumed.
|
|
2206
2210
|
*/
|
|
2207
2211
|
export type ComputeForecastRequest = {
|
|
2208
2212
|
/**
|
|
@@ -3677,7 +3681,7 @@ export type CreateForecastRequest = {
|
|
|
3677
3681
|
/**
|
|
3678
3682
|
* Base Period
|
|
3679
3683
|
*
|
|
3680
|
-
*
|
|
3684
|
+
* Origin month (`YYYY-MM`) of the authored window. Defaults to the fiscal calendar's closed-through period, else the newest actual report month. Resolved and stored at create time, and it never moves afterwards — every lever is keyed to a month inside `base_period + 1 … + horizon_months`, so moving it would mean restating all of them. `base_anchor` decides whether the walk still *seeds* here once months close under it.
|
|
3681
3685
|
*/
|
|
3682
3686
|
base_period?: string | null;
|
|
3683
3687
|
/**
|
|
@@ -3759,10 +3763,11 @@ export type CreateGraphRequest = {
|
|
|
3759
3763
|
*
|
|
3760
3764
|
* Create an Information Block. The body is a discriminated union on
|
|
3761
3765
|
* `block_type`: pick the arm matching the block type you want to
|
|
3762
|
-
* create. The schedule
|
|
3763
|
-
*
|
|
3764
|
-
*
|
|
3765
|
-
*
|
|
3766
|
+
* create. The schedule and forecast arms carry fully typed payloads;
|
|
3767
|
+
* the remaining arms accept an untyped payload and return HTTP 501
|
|
3768
|
+
* with a hint naming the operation that constructs them (statements
|
|
3769
|
+
* via `create-report`, disclosure and metric structures via
|
|
3770
|
+
* `create-taxonomy-block`).
|
|
3766
3771
|
*/
|
|
3767
3772
|
export type CreateInformationBlockRequest = ({
|
|
3768
3773
|
block_type: 'schedule';
|
|
@@ -4927,8 +4932,8 @@ export type DeleteGraphOp = {
|
|
|
4927
4932
|
*
|
|
4928
4933
|
* Delete an Information Block. The body is a discriminated union on
|
|
4929
4934
|
* `block_type` mirroring `CreateInformationBlockRequest`. The schedule
|
|
4930
|
-
*
|
|
4931
|
-
* return HTTP 501.
|
|
4935
|
+
* and forecast arms carry fully typed delete payloads; the remaining
|
|
4936
|
+
* arms return HTTP 501.
|
|
4932
4937
|
*/
|
|
4933
4938
|
export type DeleteInformationBlockRequest = ({
|
|
4934
4939
|
block_type: 'schedule';
|
|
@@ -6744,11 +6749,11 @@ export type EventHandlerResponse = {
|
|
|
6744
6749
|
* each draft entry posts as its own JournalEntry, with the entry id as
|
|
6745
6750
|
* the RequestId, and its QuickBooks id is recorded per entry on
|
|
6746
6751
|
* `event.metadata.qb_entry_ids`. The event goes `fulfilled` once no
|
|
6747
|
-
* draft remains
|
|
6748
|
-
*
|
|
6752
|
+
* draft remains. When QuickBooks rejects an entry, what landed is kept,
|
|
6753
|
+
* the status is unchanged, and the error is stamped on
|
|
6754
|
+
* `event.metadata.last_outbound_error` and returned as `qb_error`.
|
|
6749
6755
|
*
|
|
6750
|
-
* `'native'
|
|
6751
|
-
* RoboSystems IS the source of truth, no outbound publish needed.
|
|
6756
|
+
* Events on `'native'` or `'shadow'` books pass through with no QB write.
|
|
6752
6757
|
*/
|
|
6753
6758
|
export type ExecuteEventBlockRequest = {
|
|
6754
6759
|
/**
|
|
@@ -6780,7 +6785,7 @@ export type ExecuteEventBlockResponse = {
|
|
|
6780
6785
|
/**
|
|
6781
6786
|
* Status
|
|
6782
6787
|
*
|
|
6783
|
-
* The event's status after the call. Unchanged when no write fired (native policy, a source that does not publish) or when drafts in a later period are still unpublished. `'fulfilled'` once every draft entry of the event is in QuickBooks and posted.
|
|
6788
|
+
* The event's status after the call. Unchanged when no write fired (native policy, a source that does not publish) or when drafts in a later period are still unpublished. `'fulfilled'` once every draft entry of the event is in QuickBooks and posted. Also unchanged when QuickBooks rejected an entry — see `qb_error`; retry after fixing the underlying issue.
|
|
6784
6789
|
*/
|
|
6785
6790
|
status: string;
|
|
6786
6791
|
/**
|
|
@@ -9038,7 +9043,7 @@ export type InformationModelResponse = {
|
|
|
9038
9043
|
/**
|
|
9039
9044
|
* Concept Arrangement
|
|
9040
9045
|
*
|
|
9041
|
-
* roll_up | roll_forward |
|
|
9046
|
+
* A Concept Arrangement Pattern: set | roll_up | roll_forward | roll_forward_info | adjustment | variance | arithmetic | text_block, a text-block or detail level (level1_textblock … level4_detail, table_equivalent_textblock), or grid | compound_fact. Null for block types where the concept arrangement is implicit in their mechanics.
|
|
9042
9047
|
*/
|
|
9043
9048
|
concept_arrangement?: string | null;
|
|
9044
9049
|
/**
|
|
@@ -9615,7 +9620,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9615
9620
|
/**
|
|
9616
9621
|
* Flow Qname
|
|
9617
9622
|
*
|
|
9618
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates
|
|
9623
|
+
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`list-flow-candidates` over MCP and `flowCandidates` over GraphQL list 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, and a tag does not spread to the other side. Refused when it is not a row of the entity's cash flow statement.
|
|
9619
9624
|
*/
|
|
9620
9625
|
flow_qname?: string | null;
|
|
9621
9626
|
/**
|
|
@@ -9627,7 +9632,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9627
9632
|
/**
|
|
9628
9633
|
* Metadata
|
|
9629
9634
|
*
|
|
9630
|
-
* Optional per-line metadata stamped on `LineItem.metadata_`. Used to carry source-system fields the standard columns don't cover — e.g. an external
|
|
9635
|
+
* Optional per-line metadata stamped on `LineItem.metadata_`. Used to carry source-system fields the standard columns don't cover — e.g. an external memo or a cost-center hint. A flow tag goes in `flow_qname`, not here. Pass-through is non-validating; the renderer / filter engine reads keys it knows about and ignores the rest. `None` is normalized to `{}` at persist time.
|
|
9631
9636
|
*/
|
|
9632
9637
|
metadata?: {
|
|
9633
9638
|
[key: string]: unknown;
|
|
@@ -15188,7 +15193,7 @@ export type OperatorRunDetail = {
|
|
|
15188
15193
|
/**
|
|
15189
15194
|
* Transcript
|
|
15190
15195
|
*
|
|
15191
|
-
* One entry per model call, in order: the input added since the previous call (the question, then each turn's tool results), the model's output blocks (text and tool calls), stop reason, token usage and
|
|
15196
|
+
* One entry per model call, in order: the input added since the previous call (the question, then each turn's tool results), the model's output blocks (text and tool calls), stop reason, token usage, credits and sampling settings. The first entry also carries the SHA-256 and size of the system prompt and the SHA-256 and names of the tools offered; later entries repeat them only when they change
|
|
15192
15197
|
*/
|
|
15193
15198
|
transcript?: Array<{
|
|
15194
15199
|
[key: string]: unknown;
|
|
@@ -16344,19 +16349,19 @@ export type PortfolioBlockEnvelope = {
|
|
|
16344
16349
|
/**
|
|
16345
16350
|
* Positions
|
|
16346
16351
|
*
|
|
16347
|
-
*
|
|
16352
|
+
* The portfolio's active positions; disposed ones are not included.
|
|
16348
16353
|
*/
|
|
16349
16354
|
positions: Array<PositionBlock>;
|
|
16350
16355
|
/**
|
|
16351
16356
|
* Total Cost Basis Dollars
|
|
16352
16357
|
*
|
|
16353
|
-
* Sum of `cost_basis_dollars` across
|
|
16358
|
+
* Sum of `cost_basis_dollars` across the active positions.
|
|
16354
16359
|
*/
|
|
16355
16360
|
total_cost_basis_dollars: number;
|
|
16356
16361
|
/**
|
|
16357
16362
|
* Total Current Value Dollars
|
|
16358
16363
|
*
|
|
16359
|
-
* Sum of `current_value_dollars` across
|
|
16364
|
+
* Sum of `current_value_dollars` across the marked active positions; an unmarked one adds nothing. `null` only when no active position has a mark.
|
|
16360
16365
|
*/
|
|
16361
16366
|
total_current_value_dollars?: number | null;
|
|
16362
16367
|
/**
|
|
@@ -16714,7 +16719,7 @@ export type PositionBlock = {
|
|
|
16714
16719
|
/**
|
|
16715
16720
|
* Status
|
|
16716
16721
|
*
|
|
16717
|
-
* Lifecycle state (`active`, `disposed
|
|
16722
|
+
* Lifecycle state (`active`, `disposed`). See `PositionResponse.status` for the full vocabulary.
|
|
16718
16723
|
*/
|
|
16719
16724
|
status: string;
|
|
16720
16725
|
/**
|
|
@@ -18759,10 +18764,12 @@ export type RenderingPeriodLite = {
|
|
|
18759
18764
|
*
|
|
18760
18765
|
* One row of a server-side rendered statement.
|
|
18761
18766
|
*
|
|
18762
|
-
*
|
|
18767
|
+
* Drawn from :class:`FactRow` in
|
|
18763
18768
|
* :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
|
|
18764
|
-
* API boundary so envelope consumers don't depend on that module.
|
|
18765
|
-
*
|
|
18769
|
+
* API boundary so envelope consumers don't depend on that module. It does not
|
|
18770
|
+
* carry FactRow's `is_abstract`, `position` or `period_role` (the start/end
|
|
18771
|
+
* role that tells a roll-forward's two balance rows apart).
|
|
18772
|
+
* `values` holds one entry per period column in :class:`RenderingLite.periods`.
|
|
18766
18773
|
*/
|
|
18767
18774
|
export type RenderingRowLite = {
|
|
18768
18775
|
/**
|
|
@@ -22806,7 +22813,7 @@ export type UpdateEventBlockRequest = {
|
|
|
22806
22813
|
/**
|
|
22807
22814
|
* Discharge Allocations
|
|
22808
22815
|
*
|
|
22809
|
-
* What this payment settles, document by document: one row per invoice or bill with the positive cents applied to it, together at most the payment's amount (the rest is unapplied). Replaces any held; an empty list clears them, and the settlement link becomes the first row's. Each must be an obligation of this event's entity, not voided: an invoice for money in, a bill for money out. A person chooses them; the open items a bank line may settle are `dischargeCandidates` over GraphQL.
|
|
22816
|
+
* What this payment settles, document by document: one row per invoice or bill with the positive cents applied to it, together at most the payment's amount (the rest is unapplied). Replaces any held; an empty list clears them, and the settlement link becomes the first row's. Each must be an obligation of this event's entity, not voided: an invoice for money in, a bill for money out. A person chooses them; the open items a bank line may settle are `list-discharge-candidates` over MCP and `dischargeCandidates` over GraphQL.
|
|
22810
22817
|
*/
|
|
22811
22818
|
discharge_allocations?: Array<DischargeAllocation> | null;
|
|
22812
22819
|
/**
|
|
@@ -23018,9 +23025,9 @@ export type UpdateGraphMetadataOp = {
|
|
|
23018
23025
|
*
|
|
23019
23026
|
* Update an Information Block. The body is a discriminated union on
|
|
23020
23027
|
* `block_type` mirroring `CreateInformationBlockRequest`. The schedule
|
|
23021
|
-
*
|
|
23022
|
-
* return HTTP 501 (statements are library-seeded;
|
|
23023
|
-
*
|
|
23028
|
+
* and forecast arms carry fully typed update payloads; the remaining
|
|
23029
|
+
* arms return HTTP 501 (statements are library-seeded; the others
|
|
23030
|
+
* change through their own operations).
|
|
23024
23031
|
*/
|
|
23025
23032
|
export type UpdateInformationBlockRequest = ({
|
|
23026
23033
|
block_type: 'schedule';
|
|
@@ -23308,7 +23315,7 @@ export type UpdateSecurityOperation = {
|
|
|
23308
23315
|
/**
|
|
23309
23316
|
* Terms
|
|
23310
23317
|
*
|
|
23311
|
-
* Replacement terms blob.
|
|
23318
|
+
* Replacement terms blob. Omit to leave existing terms unchanged; pass `{}` to clear them.
|
|
23312
23319
|
*/
|
|
23313
23320
|
terms?: {
|
|
23314
23321
|
[key: string]: unknown;
|
|
@@ -23864,20 +23871,17 @@ export type ViewMetadata = {
|
|
|
23864
23871
|
/**
|
|
23865
23872
|
* ViewProjections
|
|
23866
23873
|
*
|
|
23867
|
-
* The
|
|
23868
|
-
*
|
|
23869
|
-
* BusinessRules), surfaced at the envelope boundary.
|
|
23874
|
+
* The server-computed View projections of an Information Block,
|
|
23875
|
+
* surfaced at the envelope boundary.
|
|
23870
23876
|
*
|
|
23871
|
-
*
|
|
23872
|
-
*
|
|
23873
|
-
*
|
|
23874
|
-
*
|
|
23875
|
-
*
|
|
23876
|
-
*
|
|
23877
|
-
*
|
|
23878
|
-
*
|
|
23879
|
-
* for metric blocks. Projections without backend support yet are empty;
|
|
23880
|
-
* `fact_table` is derivable from `InformationBlockEnvelope.facts`.
|
|
23877
|
+
* Two are computed at envelope-build time when their source data is
|
|
23878
|
+
* available: `rendering` (the rendered rows and periods) for the
|
|
23879
|
+
* statement family, disclosures, metrics, forecasts and reconciliations,
|
|
23880
|
+
* and `chart` (panel/series config over the rendering's rows and
|
|
23881
|
+
* periods) for metric blocks. The other views a client shows are
|
|
23882
|
+
* derived from the envelope itself — a fact table from
|
|
23883
|
+
* `InformationBlockEnvelope.facts`, rule outcomes from its rules and
|
|
23884
|
+
* verification results.
|
|
23881
23885
|
*/
|
|
23882
23886
|
export type ViewProjections = {
|
|
23883
23887
|
rendering?: RenderingLite | null;
|
|
@@ -24047,24 +24051,26 @@ export type CreateForecastArm = {
|
|
|
24047
24051
|
/**
|
|
24048
24052
|
* _CreateLegacyArm
|
|
24049
24053
|
*
|
|
24050
|
-
* Create-information-block body for block types
|
|
24051
|
-
*
|
|
24054
|
+
* Create-information-block body for block types constructed through
|
|
24055
|
+
* another operation.
|
|
24052
24056
|
*
|
|
24053
24057
|
* Statement-family blocks (balance_sheet, income_statement,
|
|
24054
24058
|
* cash_flow_statement, equity_statement, comprehensive_income) are
|
|
24055
24059
|
* constructed via `create-report`, not this endpoint. Disclosure
|
|
24056
24060
|
* structures (regulatory_disclosure) are vocabulary, authored via
|
|
24057
24061
|
* `create-taxonomy-block`; their facts land when `create-report`
|
|
24058
|
-
* picks them. Metric
|
|
24059
|
-
*
|
|
24060
|
-
*
|
|
24061
|
-
*
|
|
24062
|
+
* picks them. Metric structures are authored via
|
|
24063
|
+
* `create-taxonomy-block` and their facts written by `compute-metrics`
|
|
24064
|
+
* or `assert-metrics`. Reconciliation blocks are created by
|
|
24065
|
+
* `refresh-reconciliations`. Calling this endpoint with one of these
|
|
24066
|
+
* block types returns HTTP 501 with a hint pointing to the correct
|
|
24067
|
+
* construction path.
|
|
24062
24068
|
*/
|
|
24063
24069
|
export type CreateLegacyArm = {
|
|
24064
24070
|
/**
|
|
24065
24071
|
* Block Type
|
|
24066
24072
|
*
|
|
24067
|
-
* Statement-family
|
|
24073
|
+
* Statement-family, disclosure, metric or reconciliation block type. The endpoint returns 501 for these values with a hint naming the operation that constructs each.
|
|
24068
24074
|
*/
|
|
24069
24075
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
24070
24076
|
/**
|
|
@@ -24126,14 +24132,16 @@ export type DeleteForecastArm = {
|
|
|
24126
24132
|
* a typed delete path at the API boundary.
|
|
24127
24133
|
*
|
|
24128
24134
|
* Statement-family blocks cannot be deleted per tenant (the underlying
|
|
24129
|
-
* Report should be archived via the report APIs instead).
|
|
24130
|
-
*
|
|
24135
|
+
* Report should be archived via the report APIs instead). Disclosure
|
|
24136
|
+
* and metric structures are removed through the taxonomy-block
|
|
24137
|
+
* operations; a reconciliation stops holding the close through
|
|
24138
|
+
* `set-reconciliation-policy`. Calls return HTTP 501.
|
|
24131
24139
|
*/
|
|
24132
24140
|
export type DeleteLegacyArm = {
|
|
24133
24141
|
/**
|
|
24134
24142
|
* Block Type
|
|
24135
24143
|
*
|
|
24136
|
-
* Statement-family
|
|
24144
|
+
* Statement-family, disclosure, metric or reconciliation block type. Deletion returns 501 — statements are library-seeded (archive the underlying Report instead); the others are managed through their own operations, named in the 501's hint.
|
|
24137
24145
|
*/
|
|
24138
24146
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
24139
24147
|
/**
|
|
@@ -24191,18 +24199,19 @@ export type UpdateForecastArm = {
|
|
|
24191
24199
|
/**
|
|
24192
24200
|
* _UpdateLegacyArm
|
|
24193
24201
|
*
|
|
24194
|
-
* Update-information-block body for block types
|
|
24195
|
-
*
|
|
24202
|
+
* Update-information-block body for block types updated through
|
|
24203
|
+
* another operation.
|
|
24196
24204
|
*
|
|
24197
|
-
* Statement-family blocks are library-seeded and immutable.
|
|
24198
|
-
*
|
|
24199
|
-
*
|
|
24205
|
+
* Statement-family blocks are library-seeded and immutable. Disclosure
|
|
24206
|
+
* and metric structures change through the taxonomy-block operations;
|
|
24207
|
+
* a reconciliation's policy through `set-reconciliation-policy`.
|
|
24208
|
+
* Calling this endpoint with one of these block types returns HTTP 501.
|
|
24200
24209
|
*/
|
|
24201
24210
|
export type UpdateLegacyArm = {
|
|
24202
24211
|
/**
|
|
24203
24212
|
* Block Type
|
|
24204
24213
|
*
|
|
24205
|
-
* Statement-family
|
|
24214
|
+
* Statement-family, disclosure, metric or reconciliation block type. Updates return 501 — statement Structures are library-seeded; the others change through their own operations, named in the 501's hint.
|
|
24206
24215
|
*/
|
|
24207
24216
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
24208
24217
|
/**
|
|
@@ -27271,7 +27280,7 @@ export type GetOperatorMetadataData = {
|
|
|
27271
27280
|
/**
|
|
27272
27281
|
* Operator Type
|
|
27273
27282
|
*
|
|
27274
|
-
* Operator type identifier
|
|
27283
|
+
* Operator type identifier: 'analyst', 'mapping' or 'author'
|
|
27275
27284
|
*/
|
|
27276
27285
|
operator_type: string;
|
|
27277
27286
|
};
|
package/sdk.gen.d.ts
CHANGED
|
@@ -364,7 +364,7 @@ export declare const listOperators: <ThrowOnError extends boolean = false>(optio
|
|
|
364
364
|
/**
|
|
365
365
|
* Auto-select Operator for Query
|
|
366
366
|
*
|
|
367
|
-
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (
|
|
367
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
368
368
|
*/
|
|
369
369
|
export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>;
|
|
370
370
|
/**
|
|
@@ -374,7 +374,7 @@ export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>
|
|
|
374
374
|
/**
|
|
375
375
|
* Execute Specific Operator
|
|
376
376
|
*
|
|
377
|
-
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name)
|
|
377
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only) and `author` (makes the change a request asks for, such as metric and forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes that are reversible or wait on a person's step; needs write access to the graph). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
378
378
|
*/
|
|
379
379
|
export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>;
|
|
380
380
|
/**
|
|
@@ -886,7 +886,7 @@ export declare const changeCalendarStart: <ThrowOnError extends boolean = false>
|
|
|
886
886
|
/**
|
|
887
887
|
* Initialize Chart of Accounts
|
|
888
888
|
*
|
|
889
|
-
* Create the graph's chart of accounts from a shipped template — the fresh-company path to native books. Use when the graph has NO chart (a QuickBooks-synced tenant never needs this: its chart arrives with the sync and stays after a sever) and before connecting a bank feed, which needs a chart to resolve against. Templates: `saas` (subscription software), `services` (professional services), `product` (inventory and COGS)
|
|
889
|
+
* Create the graph's chart of accounts from a shipped template — the fresh-company path to native books. Use when the graph has NO chart (a QuickBooks-synced tenant never needs this: its chart arrives with the sync and stays after a sever) and before connecting a bank feed, which needs a chart to resolve against. Templates: `saas` (subscription software), `services` (professional services), `product` (inventory and COGS), `consolidation` (a group's consolidation entity — the adjustments column, never an operating company's chart). Creates the chart, its `coa_mapping` structure and the template's CoA → rs-gaap mapping associations in one transaction, with the equity rows mapped by the entity's legal form (`entity_type`, defaulting to the entity's). Each entity of the group keeps its own chart: `entity_id` names a subsidiary, omitted means the group parent. One-time per entity: 409 once that entity has a chart — a chart is never replaced. Customize afterwards with update-taxonomy-block; accounts that carry activity are never deleted.
|
|
890
890
|
*
|
|
891
891
|
* **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.
|
|
892
892
|
*/
|
|
@@ -918,7 +918,7 @@ export declare const changeReportingStyle: <ThrowOnError extends boolean = false
|
|
|
918
918
|
/**
|
|
919
919
|
* Link Bank Account
|
|
920
920
|
*
|
|
921
|
-
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them.
|
|
921
|
+
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them. The group's accounts are `list-bank-accounts` over MCP and the `bankAccounts` GraphQL field.
|
|
922
922
|
*
|
|
923
923
|
* **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.
|
|
924
924
|
*/
|
|
@@ -966,7 +966,7 @@ export declare const createMappingAssociation: <ThrowOnError extends boolean = f
|
|
|
966
966
|
/**
|
|
967
967
|
* Delete Mapping Association
|
|
968
968
|
*
|
|
969
|
-
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one.
|
|
969
|
+
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one. The association id is `list-element-arcs` over MCP and the `libraryElementArcs` GraphQL field. Library-seeded rows cannot be deleted (403). An edge for an account with landed history in a closed month cannot be removed on its own (422): move the account with `create-mapping-association` and `replaces_association_id` instead.
|
|
970
970
|
*
|
|
971
971
|
* **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.
|
|
972
972
|
*/
|
|
@@ -982,7 +982,7 @@ export declare const autoMapElements: <ThrowOnError extends boolean = false>(opt
|
|
|
982
982
|
/**
|
|
983
983
|
* Create Information Block
|
|
984
984
|
*
|
|
985
|
-
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch.
|
|
985
|
+
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch. Only schedule and forecast are constructed here; the other block types raise 501 with a hint naming their own operation (statements: create-report; disclosure and metric structures: create-taxonomy-block). Authoring schedules for a close? Call `get-close-playbook` (mode='initiate') first — one schedule is a single debit/credit element pair, so multi-line entries become multiple schedules, and element ids must be real (discover via get-graph-schema / get-unmapped-elements / suggest-mapping).
|
|
986
986
|
*
|
|
987
987
|
* **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.
|
|
988
988
|
*/
|
|
@@ -990,7 +990,7 @@ export declare const createInformationBlock: <ThrowOnError extends boolean = fal
|
|
|
990
990
|
/**
|
|
991
991
|
* Update Information Block
|
|
992
992
|
*
|
|
993
|
-
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler.
|
|
993
|
+
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler. Only schedule and forecast blocks update here; the statement family (library-seeded and immutable), disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that changes them.
|
|
994
994
|
*
|
|
995
995
|
* **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.
|
|
996
996
|
*/
|
|
@@ -998,7 +998,7 @@ export declare const updateInformationBlock: <ThrowOnError extends boolean = fal
|
|
|
998
998
|
/**
|
|
999
999
|
* Delete Information Block
|
|
1000
1000
|
*
|
|
1001
|
-
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name).
|
|
1001
|
+
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name). Only schedule and forecast blocks delete here; statement, disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that manages them.
|
|
1002
1002
|
*
|
|
1003
1003
|
* **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.
|
|
1004
1004
|
*/
|
|
@@ -1030,7 +1030,7 @@ export declare const assertMetrics: <ThrowOnError extends boolean = false>(optio
|
|
|
1030
1030
|
/**
|
|
1031
1031
|
* Compute Forecast for a Forecast Block
|
|
1032
1032
|
*
|
|
1033
|
-
* Walks a forecast block's driver cascade month-by-month forward from its
|
|
1033
|
+
* Walks a forecast block's driver cascade month-by-month forward from its anchor (with base_anchor='seam', the default, the newest closed month inside the horizon; with 'fixed', the block's base_period): lever-driven rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines, calc-DAG subtotals — upserting per forward month a scenario income-statement FactSet, a balance-sheet set (the full roll when the anchor month has an actual balance sheet, else only the rule-driven working-capital instants) and a derived cash-flow set when an actual one exists, all keyed by the block's scenario_id (NULL = actuals; scenario reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months or unbound operands are skipped with a reason (their targets fall back to carry-forward). Each month's sets are verified; a month that fails halts the walk there (halted_at), since every later month would be derived from it. Deterministic and non-AI — no credits consumed.
|
|
1034
1034
|
*
|
|
1035
1035
|
* **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.
|
|
1036
1036
|
*/
|
|
@@ -1110,7 +1110,7 @@ export declare const updateEventBlock: <ThrowOnError extends boolean = false>(op
|
|
|
1110
1110
|
/**
|
|
1111
1111
|
* Execute Event Block
|
|
1112
1112
|
*
|
|
1113
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains
|
|
1113
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains. On rejection what landed is kept, the status is unchanged and the error is stamped on event.metadata.last_outbound_error (and returned as qb_error). Events on 'native' or 'shadow' books pass through with no QB write. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
1114
1114
|
*
|
|
1115
1115
|
* **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.
|
|
1116
1116
|
*/
|
|
@@ -1302,7 +1302,7 @@ export declare const promoteObligations: <ThrowOnError extends boolean = false>(
|
|
|
1302
1302
|
/**
|
|
1303
1303
|
* Preview Schedule
|
|
1304
1304
|
*
|
|
1305
|
-
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (
|
|
1305
|
+
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new definition) while nothing has posted, `terminate_and_succeed` after.
|
|
1306
1306
|
*
|
|
1307
1307
|
* **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.
|
|
1308
1308
|
*/
|
|
@@ -1406,7 +1406,7 @@ export declare const deletePublishList: <ThrowOnError extends boolean = false>(o
|
|
|
1406
1406
|
/**
|
|
1407
1407
|
* Add Members to Publish List
|
|
1408
1408
|
*
|
|
1409
|
-
* Add one or more recipient graphs to a publish list. Targets must exist and
|
|
1409
|
+
* Add one or more recipient graphs to a publish list. Targets must exist and carry the roboledger or roboinvestor extension. Self-graph rejected (422); already-member rejected (409).
|
|
1410
1410
|
*
|
|
1411
1411
|
* **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.
|
|
1412
1412
|
*/
|
|
@@ -1542,7 +1542,7 @@ export declare const deletePortfolioBlock: <ThrowOnError extends boolean = false
|
|
|
1542
1542
|
/**
|
|
1543
1543
|
* Create Security
|
|
1544
1544
|
*
|
|
1545
|
-
* Register a security (common stock, preferred stock, warrant, convertible note, etc.)
|
|
1545
|
+
* Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner. Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake attribution.
|
|
1546
1546
|
*
|
|
1547
1547
|
* **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.
|
|
1548
1548
|
*/
|
package/sdk.gen.js
CHANGED
|
@@ -718,7 +718,7 @@ exports.listOperators = listOperators;
|
|
|
718
718
|
/**
|
|
719
719
|
* Auto-select Operator for Query
|
|
720
720
|
*
|
|
721
|
-
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (
|
|
721
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (automatic Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `author` makes writes, so it is never chosen here: call it by name. `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
722
722
|
*/
|
|
723
723
|
const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
724
724
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -742,7 +742,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
|
|
|
742
742
|
/**
|
|
743
743
|
* Execute Specific Operator
|
|
744
744
|
*
|
|
745
|
-
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name)
|
|
745
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name), `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only) and `author` (makes the change a request asks for, such as metric and forecast blocks, counterparties, memories, draft reports and inbox classifications, through writes that are reversible or wait on a person's step; needs write access to the graph). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
746
746
|
*/
|
|
747
747
|
const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
748
748
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1800,7 +1800,7 @@ exports.changeCalendarStart = changeCalendarStart;
|
|
|
1800
1800
|
/**
|
|
1801
1801
|
* Initialize Chart of Accounts
|
|
1802
1802
|
*
|
|
1803
|
-
* Create the graph's chart of accounts from a shipped template — the fresh-company path to native books. Use when the graph has NO chart (a QuickBooks-synced tenant never needs this: its chart arrives with the sync and stays after a sever) and before connecting a bank feed, which needs a chart to resolve against. Templates: `saas` (subscription software), `services` (professional services), `product` (inventory and COGS)
|
|
1803
|
+
* Create the graph's chart of accounts from a shipped template — the fresh-company path to native books. Use when the graph has NO chart (a QuickBooks-synced tenant never needs this: its chart arrives with the sync and stays after a sever) and before connecting a bank feed, which needs a chart to resolve against. Templates: `saas` (subscription software), `services` (professional services), `product` (inventory and COGS), `consolidation` (a group's consolidation entity — the adjustments column, never an operating company's chart). Creates the chart, its `coa_mapping` structure and the template's CoA → rs-gaap mapping associations in one transaction, with the equity rows mapped by the entity's legal form (`entity_type`, defaulting to the entity's). Each entity of the group keeps its own chart: `entity_id` names a subsidiary, omitted means the group parent. One-time per entity: 409 once that entity has a chart — a chart is never replaced. Customize afterwards with update-taxonomy-block; accounts that carry activity are never deleted.
|
|
1804
1804
|
*
|
|
1805
1805
|
* **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.
|
|
1806
1806
|
*/
|
|
@@ -1868,7 +1868,7 @@ exports.changeReportingStyle = changeReportingStyle;
|
|
|
1868
1868
|
/**
|
|
1869
1869
|
* Link Bank Account
|
|
1870
1870
|
*
|
|
1871
|
-
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them.
|
|
1871
|
+
* Point a bank feed's account at a chart account. Name `element_id` for an existing active account, or `entity_id` alone to create one in that entity's chart. The chart the account is in decides whose books the feed's lines go into, so this is also how a feed account is bound to a subsidiary. Lines still in the inbox move with it (across an entity change their suggestion is resolved again on the new chart, and a classification that named the old entity's account is dropped); posted entries stay where they were posted. An account another connection already feeds is refused, as is an entity whose books QuickBooks keeps (the group parent, while QuickBooks is connected). An account the feed created and then left stays on its chart as an ordinary account. A sync already in flight when the link moves can still land a line or two on the old account; running this again moves them. The group's accounts are `list-bank-accounts` over MCP and the `bankAccounts` GraphQL field.
|
|
1872
1872
|
*
|
|
1873
1873
|
* **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.
|
|
1874
1874
|
*/
|
|
@@ -1970,7 +1970,7 @@ exports.createMappingAssociation = createMappingAssociation;
|
|
|
1970
1970
|
/**
|
|
1971
1971
|
* Delete Mapping Association
|
|
1972
1972
|
*
|
|
1973
|
-
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one.
|
|
1973
|
+
* Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains; only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then `create-mapping-association` the right one. The association id is `list-element-arcs` over MCP and the `libraryElementArcs` GraphQL field. Library-seeded rows cannot be deleted (403). An edge for an account with landed history in a closed month cannot be removed on its own (422): move the account with `create-mapping-association` and `replaces_association_id` instead.
|
|
1974
1974
|
*
|
|
1975
1975
|
* **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.
|
|
1976
1976
|
*/
|
|
@@ -2004,7 +2004,7 @@ exports.autoMapElements = autoMapElements;
|
|
|
2004
2004
|
/**
|
|
2005
2005
|
* Create Information Block
|
|
2006
2006
|
*
|
|
2007
|
-
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch.
|
|
2007
|
+
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch. Only schedule and forecast are constructed here; the other block types raise 501 with a hint naming their own operation (statements: create-report; disclosure and metric structures: create-taxonomy-block). Authoring schedules for a close? Call `get-close-playbook` (mode='initiate') first — one schedule is a single debit/credit element pair, so multi-line entries become multiple schedules, and element ids must be real (discover via get-graph-schema / get-unmapped-elements / suggest-mapping).
|
|
2008
2008
|
*
|
|
2009
2009
|
* **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.
|
|
2010
2010
|
*/
|
|
@@ -2021,7 +2021,7 @@ exports.createInformationBlock = createInformationBlock;
|
|
|
2021
2021
|
/**
|
|
2022
2022
|
* Update Information Block
|
|
2023
2023
|
*
|
|
2024
|
-
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler.
|
|
2024
|
+
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler. Only schedule and forecast blocks update here; the statement family (library-seeded and immutable), disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that changes them.
|
|
2025
2025
|
*
|
|
2026
2026
|
* **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.
|
|
2027
2027
|
*/
|
|
@@ -2038,7 +2038,7 @@ exports.updateInformationBlock = updateInformationBlock;
|
|
|
2038
2038
|
/**
|
|
2039
2039
|
* Delete Information Block
|
|
2040
2040
|
*
|
|
2041
|
-
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name).
|
|
2041
|
+
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name). Only schedule and forecast blocks delete here; statement, disclosure, metric and reconciliation blocks surface 501 with a hint naming the operation that manages them.
|
|
2042
2042
|
*
|
|
2043
2043
|
* **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.
|
|
2044
2044
|
*/
|
|
@@ -2106,7 +2106,7 @@ exports.assertMetrics = assertMetrics;
|
|
|
2106
2106
|
/**
|
|
2107
2107
|
* Compute Forecast for a Forecast Block
|
|
2108
2108
|
*
|
|
2109
|
-
* Walks a forecast block's driver cascade month-by-month forward from its
|
|
2109
|
+
* Walks a forecast block's driver cascade month-by-month forward from its anchor (with base_anchor='seam', the default, the newest closed month inside the horizon; with 'fixed', the block's base_period): lever-driven rs-driver Derive rules in dependency order, carry-forward for unmodeled income-statement lines, calc-DAG subtotals — upserting per forward month a scenario income-statement FactSet, a balance-sheet set (the full roll when the anchor month has an actual balance sheet, else only the rule-driven working-capital instants) and a derived cash-flow set when an actual one exists, all keyed by the block's scenario_id (NULL = actuals; scenario reads pass it as a filter). Re-running replaces each month's values. Rules with missing lever months or unbound operands are skipped with a reason (their targets fall back to carry-forward). Each month's sets are verified; a month that fails halts the walk there (halted_at), since every later month would be derived from it. Deterministic and non-AI — no credits consumed.
|
|
2110
2110
|
*
|
|
2111
2111
|
* **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.
|
|
2112
2112
|
*/
|
|
@@ -2276,7 +2276,7 @@ exports.updateEventBlock = updateEventBlock;
|
|
|
2276
2276
|
/**
|
|
2277
2277
|
* Execute Event Block
|
|
2278
2278
|
*
|
|
2279
|
-
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains
|
|
2279
|
+
* For events on a connection with write_policy='qb_authoritative' or 'hybrid', publish the event's draft GL entries to the source-of-truth system (QuickBooks), each as its own JournalEntry. Records the QuickBooks ids per entry on event.metadata.qb_entry_ids and promotes the published entries to 'posted'; the event goes 'fulfilled' once no draft remains. On rejection what landed is kept, the status is unchanged and the error is stamped on event.metadata.last_outbound_error (and returned as qb_error). Events on 'native' or 'shadow' books pass through with no QB write. Only the group parent's books are QuickBooks': an event on a subsidiary's books is refused.
|
|
2280
2280
|
*
|
|
2281
2281
|
* **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.
|
|
2282
2282
|
*/
|
|
@@ -2684,7 +2684,7 @@ exports.promoteObligations = promoteObligations;
|
|
|
2684
2684
|
/**
|
|
2685
2685
|
* Preview Schedule
|
|
2686
2686
|
*
|
|
2687
|
-
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (
|
|
2687
|
+
* Generate a schedule from a definition without keeping it: the same generator and guards as creating one (block_type='schedule' on create-information-block), run and rolled back. Returns the envelope create would leave (its ids provisional) and the period-by-period roll-forward: the balance the schedule carries on the account it credits (a loan's: the note), opening, the period's amount, closing, and for a loan the interest, payment, principal and current portion. Show it to the person before asking to create. A definition create would refuse (a roll-forward that climbs where it should fall, legs that do not balance) is refused here with the period that breaks. `warnings` names any active schedule already posting the same accounts in the same months. With `replaces_structure_id`, `replaces` says what the schedule being edited or recreated has posted, by month, and the path the change takes: `rebuild` (the schedule regenerated in place from the new definition) while nothing has posted, `terminate_and_succeed` after.
|
|
2688
2688
|
*
|
|
2689
2689
|
* **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.
|
|
2690
2690
|
*/
|
|
@@ -2905,7 +2905,7 @@ exports.deletePublishList = deletePublishList;
|
|
|
2905
2905
|
/**
|
|
2906
2906
|
* Add Members to Publish List
|
|
2907
2907
|
*
|
|
2908
|
-
* Add one or more recipient graphs to a publish list. Targets must exist and
|
|
2908
|
+
* Add one or more recipient graphs to a publish list. Targets must exist and carry the roboledger or roboinvestor extension. Self-graph rejected (422); already-member rejected (409).
|
|
2909
2909
|
*
|
|
2910
2910
|
* **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.
|
|
2911
2911
|
*/
|
|
@@ -3194,7 +3194,7 @@ exports.deletePortfolioBlock = deletePortfolioBlock;
|
|
|
3194
3194
|
/**
|
|
3195
3195
|
* Create Security
|
|
3196
3196
|
*
|
|
3197
|
-
* Register a security (common stock, preferred stock, warrant, convertible note, etc.)
|
|
3197
|
+
* Register a security (common stock, preferred stock, warrant, convertible note, etc.) in this graph's registry. Its `entity_id` is the issuer, not the holder; a portfolio's `entity_id` is the owner. Optionally cross-links to the issuer's own graph via `source_graph_id` for mutual-handshake attribution.
|
|
3198
3198
|
*
|
|
3199
3199
|
* **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.
|
|
3200
3200
|
*/
|