@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.gen.ts
CHANGED
|
@@ -729,7 +729,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
729
729
|
/**
|
|
730
730
|
* Auto-select Operator for Query
|
|
731
731
|
*
|
|
732
|
-
* 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` (
|
|
732
|
+
* 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.
|
|
733
733
|
*/
|
|
734
734
|
export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>): RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError> => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
|
|
735
735
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -753,7 +753,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
|
|
|
753
753
|
/**
|
|
754
754
|
* Execute Specific Operator
|
|
755
755
|
*
|
|
756
|
-
* 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)
|
|
756
|
+
* 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.
|
|
757
757
|
*/
|
|
758
758
|
export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>): RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError> => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
|
|
759
759
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1811,7 +1811,7 @@ export const changeCalendarStart = <ThrowOnError extends boolean = false>(option
|
|
|
1811
1811
|
/**
|
|
1812
1812
|
* Initialize Chart of Accounts
|
|
1813
1813
|
*
|
|
1814
|
-
* 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)
|
|
1814
|
+
* 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.
|
|
1815
1815
|
*
|
|
1816
1816
|
* **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.
|
|
1817
1817
|
*/
|
|
@@ -1879,7 +1879,7 @@ export const changeReportingStyle = <ThrowOnError extends boolean = false>(optio
|
|
|
1879
1879
|
/**
|
|
1880
1880
|
* Link Bank Account
|
|
1881
1881
|
*
|
|
1882
|
-
* 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.
|
|
1882
|
+
* 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.
|
|
1883
1883
|
*
|
|
1884
1884
|
* **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.
|
|
1885
1885
|
*/
|
|
@@ -1981,7 +1981,7 @@ export const createMappingAssociation = <ThrowOnError extends boolean = false>(o
|
|
|
1981
1981
|
/**
|
|
1982
1982
|
* Delete Mapping Association
|
|
1983
1983
|
*
|
|
1984
|
-
* 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.
|
|
1984
|
+
* 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.
|
|
1985
1985
|
*
|
|
1986
1986
|
* **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.
|
|
1987
1987
|
*/
|
|
@@ -2015,7 +2015,7 @@ export const autoMapElements = <ThrowOnError extends boolean = false>(options: O
|
|
|
2015
2015
|
/**
|
|
2016
2016
|
* Create Information Block
|
|
2017
2017
|
*
|
|
2018
|
-
* Generic Information Block construction entry. `block_type` selects the registered block type; `payload` is validated against that type's creation schema at dispatch.
|
|
2018
|
+
* 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).
|
|
2019
2019
|
*
|
|
2020
2020
|
* **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.
|
|
2021
2021
|
*/
|
|
@@ -2032,7 +2032,7 @@ export const createInformationBlock = <ThrowOnError extends boolean = false>(opt
|
|
|
2032
2032
|
/**
|
|
2033
2033
|
* Update Information Block
|
|
2034
2034
|
*
|
|
2035
|
-
* Generic Information Block update entry. Dispatches by `block_type` to the registered mutation handler.
|
|
2035
|
+
* 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.
|
|
2036
2036
|
*
|
|
2037
2037
|
* **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.
|
|
2038
2038
|
*/
|
|
@@ -2049,7 +2049,7 @@ export const updateInformationBlock = <ThrowOnError extends boolean = false>(opt
|
|
|
2049
2049
|
/**
|
|
2050
2050
|
* Delete Information Block
|
|
2051
2051
|
*
|
|
2052
|
-
* Generic Information Block deletion entry. Returns a thin confirmation (deleted / structure_id / block_type / name).
|
|
2052
|
+
* 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.
|
|
2053
2053
|
*
|
|
2054
2054
|
* **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.
|
|
2055
2055
|
*/
|
|
@@ -2117,7 +2117,7 @@ export const assertMetrics = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
2117
2117
|
/**
|
|
2118
2118
|
* Compute Forecast for a Forecast Block
|
|
2119
2119
|
*
|
|
2120
|
-
* Walks a forecast block's driver cascade month-by-month forward from its
|
|
2120
|
+
* 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.
|
|
2121
2121
|
*
|
|
2122
2122
|
* **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.
|
|
2123
2123
|
*/
|
|
@@ -2287,7 +2287,7 @@ export const updateEventBlock = <ThrowOnError extends boolean = false>(options:
|
|
|
2287
2287
|
/**
|
|
2288
2288
|
* Execute Event Block
|
|
2289
2289
|
*
|
|
2290
|
-
* 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
|
|
2290
|
+
* 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.
|
|
2291
2291
|
*
|
|
2292
2292
|
* **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.
|
|
2293
2293
|
*/
|
|
@@ -2695,7 +2695,7 @@ export const promoteObligations = <ThrowOnError extends boolean = false>(options
|
|
|
2695
2695
|
/**
|
|
2696
2696
|
* Preview Schedule
|
|
2697
2697
|
*
|
|
2698
|
-
* 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` (
|
|
2698
|
+
* 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.
|
|
2699
2699
|
*
|
|
2700
2700
|
* **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.
|
|
2701
2701
|
*/
|
|
@@ -2916,7 +2916,7 @@ export const deletePublishList = <ThrowOnError extends boolean = false>(options:
|
|
|
2916
2916
|
/**
|
|
2917
2917
|
* Add Members to Publish List
|
|
2918
2918
|
*
|
|
2919
|
-
* Add one or more recipient graphs to a publish list. Targets must exist and
|
|
2919
|
+
* 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).
|
|
2920
2920
|
*
|
|
2921
2921
|
* **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.
|
|
2922
2922
|
*/
|
|
@@ -3205,7 +3205,7 @@ export const deletePortfolioBlock = <ThrowOnError extends boolean = false>(optio
|
|
|
3205
3205
|
/**
|
|
3206
3206
|
* Create Security
|
|
3207
3207
|
*
|
|
3208
|
-
* Register a security (common stock, preferred stock, warrant, convertible note, etc.)
|
|
3208
|
+
* 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.
|
|
3209
3209
|
*
|
|
3210
3210
|
* **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.
|
|
3211
3211
|
*/
|
package/types.gen.d.ts
CHANGED
|
@@ -377,7 +377,7 @@ export type AddPublishListMembersOperation = {
|
|
|
377
377
|
/**
|
|
378
378
|
* Target Graph Ids
|
|
379
379
|
*
|
|
380
|
-
* Graph IDs to add. Each must exist and
|
|
380
|
+
* Graph IDs to add. Each must exist and carry the roboledger or roboinvestor extension. Self-graph rejected.
|
|
381
381
|
*/
|
|
382
382
|
target_graph_ids: Array<string>;
|
|
383
383
|
/**
|
|
@@ -2139,14 +2139,18 @@ export type CompleteDocumentUploadOp = {
|
|
|
2139
2139
|
*
|
|
2140
2140
|
* Request body for the `compute-forecast` operation.
|
|
2141
2141
|
*
|
|
2142
|
-
* Walks the scenario's driver cascade month-by-month forward from
|
|
2143
|
-
*
|
|
2144
|
-
*
|
|
2145
|
-
*
|
|
2146
|
-
*
|
|
2147
|
-
*
|
|
2148
|
-
*
|
|
2149
|
-
*
|
|
2142
|
+
* Walks the scenario's driver cascade month-by-month forward from its
|
|
2143
|
+
* anchor — the newest closed month inside the horizon under
|
|
2144
|
+
* `base_anchor='seam'` (the default), the block's `base_period` under
|
|
2145
|
+
* `'fixed'`: lever-driven Derive rules in dependency order, carry-forward
|
|
2146
|
+
* for unmodeled IS lines, calc-DAG subtotals — upserting per forward
|
|
2147
|
+
* month a scenario IS FactSet, a BS set (the full roll when the anchor
|
|
2148
|
+
* month has an actual balance sheet, else the rule-driven working-capital
|
|
2149
|
+
* instants) and a derived CF set when an actual one exists, all keyed by
|
|
2150
|
+
* the forecast block's `scenario_id`. Re-running replaces each month's
|
|
2151
|
+
* values (the compute-metrics drift semantics). A month that fails
|
|
2152
|
+
* verification halts the walk (`halted_at`). Deterministic and non-AI —
|
|
2153
|
+
* no credits consumed.
|
|
2150
2154
|
*/
|
|
2151
2155
|
export type ComputeForecastRequest = {
|
|
2152
2156
|
/**
|
|
@@ -3594,7 +3598,7 @@ export type CreateForecastRequest = {
|
|
|
3594
3598
|
/**
|
|
3595
3599
|
* Base Period
|
|
3596
3600
|
*
|
|
3597
|
-
*
|
|
3601
|
+
* 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.
|
|
3598
3602
|
*/
|
|
3599
3603
|
base_period?: string | null;
|
|
3600
3604
|
/**
|
|
@@ -3674,10 +3678,11 @@ export type CreateGraphRequest = {
|
|
|
3674
3678
|
*
|
|
3675
3679
|
* Create an Information Block. The body is a discriminated union on
|
|
3676
3680
|
* `block_type`: pick the arm matching the block type you want to
|
|
3677
|
-
* create. The schedule
|
|
3678
|
-
*
|
|
3679
|
-
*
|
|
3680
|
-
*
|
|
3681
|
+
* create. The schedule and forecast arms carry fully typed payloads;
|
|
3682
|
+
* the remaining arms accept an untyped payload and return HTTP 501
|
|
3683
|
+
* with a hint naming the operation that constructs them (statements
|
|
3684
|
+
* via `create-report`, disclosure and metric structures via
|
|
3685
|
+
* `create-taxonomy-block`).
|
|
3681
3686
|
*/
|
|
3682
3687
|
export type CreateInformationBlockRequest = ({
|
|
3683
3688
|
block_type: 'schedule';
|
|
@@ -4817,8 +4822,8 @@ export type DeleteGraphOp = {
|
|
|
4817
4822
|
*
|
|
4818
4823
|
* Delete an Information Block. The body is a discriminated union on
|
|
4819
4824
|
* `block_type` mirroring `CreateInformationBlockRequest`. The schedule
|
|
4820
|
-
*
|
|
4821
|
-
* return HTTP 501.
|
|
4825
|
+
* and forecast arms carry fully typed delete payloads; the remaining
|
|
4826
|
+
* arms return HTTP 501.
|
|
4822
4827
|
*/
|
|
4823
4828
|
export type DeleteInformationBlockRequest = ({
|
|
4824
4829
|
block_type: 'schedule';
|
|
@@ -6587,11 +6592,11 @@ export type EventHandlerResponse = {
|
|
|
6587
6592
|
* each draft entry posts as its own JournalEntry, with the entry id as
|
|
6588
6593
|
* the RequestId, and its QuickBooks id is recorded per entry on
|
|
6589
6594
|
* `event.metadata.qb_entry_ids`. The event goes `fulfilled` once no
|
|
6590
|
-
* draft remains
|
|
6591
|
-
*
|
|
6595
|
+
* draft remains. When QuickBooks rejects an entry, what landed is kept,
|
|
6596
|
+
* the status is unchanged, and the error is stamped on
|
|
6597
|
+
* `event.metadata.last_outbound_error` and returned as `qb_error`.
|
|
6592
6598
|
*
|
|
6593
|
-
* `'native'
|
|
6594
|
-
* RoboSystems IS the source of truth, no outbound publish needed.
|
|
6599
|
+
* Events on `'native'` or `'shadow'` books pass through with no QB write.
|
|
6595
6600
|
*/
|
|
6596
6601
|
export type ExecuteEventBlockRequest = {
|
|
6597
6602
|
/**
|
|
@@ -6622,7 +6627,7 @@ export type ExecuteEventBlockResponse = {
|
|
|
6622
6627
|
/**
|
|
6623
6628
|
* Status
|
|
6624
6629
|
*
|
|
6625
|
-
* 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.
|
|
6630
|
+
* 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.
|
|
6626
6631
|
*/
|
|
6627
6632
|
status: string;
|
|
6628
6633
|
/**
|
|
@@ -8836,7 +8841,7 @@ export type InformationModelResponse = {
|
|
|
8836
8841
|
/**
|
|
8837
8842
|
* Concept Arrangement
|
|
8838
8843
|
*
|
|
8839
|
-
* roll_up | roll_forward |
|
|
8844
|
+
* 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.
|
|
8840
8845
|
*/
|
|
8841
8846
|
concept_arrangement?: string | null;
|
|
8842
8847
|
/**
|
|
@@ -9399,7 +9404,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9399
9404
|
/**
|
|
9400
9405
|
* Flow Qname
|
|
9401
9406
|
*
|
|
9402
|
-
* The cash flow row this line's cash belongs to, an rs-gaap flow qname (`flowCandidates
|
|
9407
|
+
* 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.
|
|
9403
9408
|
*/
|
|
9404
9409
|
flow_qname?: string | null;
|
|
9405
9410
|
/**
|
|
@@ -9411,7 +9416,7 @@ export type JournalEntryLineItemInput = {
|
|
|
9411
9416
|
/**
|
|
9412
9417
|
* Metadata
|
|
9413
9418
|
*
|
|
9414
|
-
* Optional per-line metadata stamped on `LineItem.metadata_`. Used to carry source-system fields the standard columns don't cover — e.g. an external
|
|
9419
|
+
* 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.
|
|
9415
9420
|
*/
|
|
9416
9421
|
metadata?: {
|
|
9417
9422
|
[key: string]: unknown;
|
|
@@ -14854,7 +14859,7 @@ export type OperatorRunDetail = {
|
|
|
14854
14859
|
/**
|
|
14855
14860
|
* Transcript
|
|
14856
14861
|
*
|
|
14857
|
-
* 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
|
|
14862
|
+
* 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
|
|
14858
14863
|
*/
|
|
14859
14864
|
transcript?: Array<{
|
|
14860
14865
|
[key: string]: unknown;
|
|
@@ -15976,19 +15981,19 @@ export type PortfolioBlockEnvelope = {
|
|
|
15976
15981
|
/**
|
|
15977
15982
|
* Positions
|
|
15978
15983
|
*
|
|
15979
|
-
*
|
|
15984
|
+
* The portfolio's active positions; disposed ones are not included.
|
|
15980
15985
|
*/
|
|
15981
15986
|
positions: Array<PositionBlock>;
|
|
15982
15987
|
/**
|
|
15983
15988
|
* Total Cost Basis Dollars
|
|
15984
15989
|
*
|
|
15985
|
-
* Sum of `cost_basis_dollars` across
|
|
15990
|
+
* Sum of `cost_basis_dollars` across the active positions.
|
|
15986
15991
|
*/
|
|
15987
15992
|
total_cost_basis_dollars: number;
|
|
15988
15993
|
/**
|
|
15989
15994
|
* Total Current Value Dollars
|
|
15990
15995
|
*
|
|
15991
|
-
* Sum of `current_value_dollars` across
|
|
15996
|
+
* Sum of `current_value_dollars` across the marked active positions; an unmarked one adds nothing. `null` only when no active position has a mark.
|
|
15992
15997
|
*/
|
|
15993
15998
|
total_current_value_dollars?: number | null;
|
|
15994
15999
|
/**
|
|
@@ -16339,7 +16344,7 @@ export type PositionBlock = {
|
|
|
16339
16344
|
/**
|
|
16340
16345
|
* Status
|
|
16341
16346
|
*
|
|
16342
|
-
* Lifecycle state (`active`, `disposed
|
|
16347
|
+
* Lifecycle state (`active`, `disposed`). See `PositionResponse.status` for the full vocabulary.
|
|
16343
16348
|
*/
|
|
16344
16349
|
status: string;
|
|
16345
16350
|
/**
|
|
@@ -18337,10 +18342,12 @@ export type RenderingPeriodLite = {
|
|
|
18337
18342
|
*
|
|
18338
18343
|
* One row of a server-side rendered statement.
|
|
18339
18344
|
*
|
|
18340
|
-
*
|
|
18345
|
+
* Drawn from :class:`FactRow` in
|
|
18341
18346
|
* :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
|
|
18342
|
-
* API boundary so envelope consumers don't depend on that module.
|
|
18343
|
-
*
|
|
18347
|
+
* API boundary so envelope consumers don't depend on that module. It does not
|
|
18348
|
+
* carry FactRow's `is_abstract`, `position` or `period_role` (the start/end
|
|
18349
|
+
* role that tells a roll-forward's two balance rows apart).
|
|
18350
|
+
* `values` holds one entry per period column in :class:`RenderingLite.periods`.
|
|
18344
18351
|
*/
|
|
18345
18352
|
export type RenderingRowLite = {
|
|
18346
18353
|
/**
|
|
@@ -22287,7 +22294,7 @@ export type UpdateEventBlockRequest = {
|
|
|
22287
22294
|
/**
|
|
22288
22295
|
* Discharge Allocations
|
|
22289
22296
|
*
|
|
22290
|
-
* 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.
|
|
22297
|
+
* 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.
|
|
22291
22298
|
*/
|
|
22292
22299
|
discharge_allocations?: Array<DischargeAllocation> | null;
|
|
22293
22300
|
/**
|
|
@@ -22494,9 +22501,9 @@ export type UpdateGraphMetadataOp = {
|
|
|
22494
22501
|
*
|
|
22495
22502
|
* Update an Information Block. The body is a discriminated union on
|
|
22496
22503
|
* `block_type` mirroring `CreateInformationBlockRequest`. The schedule
|
|
22497
|
-
*
|
|
22498
|
-
* return HTTP 501 (statements are library-seeded;
|
|
22499
|
-
*
|
|
22504
|
+
* and forecast arms carry fully typed update payloads; the remaining
|
|
22505
|
+
* arms return HTTP 501 (statements are library-seeded; the others
|
|
22506
|
+
* change through their own operations).
|
|
22500
22507
|
*/
|
|
22501
22508
|
export type UpdateInformationBlockRequest = ({
|
|
22502
22509
|
block_type: 'schedule';
|
|
@@ -22775,7 +22782,7 @@ export type UpdateSecurityOperation = {
|
|
|
22775
22782
|
/**
|
|
22776
22783
|
* Terms
|
|
22777
22784
|
*
|
|
22778
|
-
* Replacement terms blob.
|
|
22785
|
+
* Replacement terms blob. Omit to leave existing terms unchanged; pass `{}` to clear them.
|
|
22779
22786
|
*/
|
|
22780
22787
|
terms?: {
|
|
22781
22788
|
[key: string]: unknown;
|
|
@@ -23316,20 +23323,17 @@ export type ViewMetadata = {
|
|
|
23316
23323
|
/**
|
|
23317
23324
|
* ViewProjections
|
|
23318
23325
|
*
|
|
23319
|
-
* The
|
|
23320
|
-
*
|
|
23321
|
-
* BusinessRules), surfaced at the envelope boundary.
|
|
23326
|
+
* The server-computed View projections of an Information Block,
|
|
23327
|
+
* surfaced at the envelope boundary.
|
|
23322
23328
|
*
|
|
23323
|
-
*
|
|
23324
|
-
*
|
|
23325
|
-
*
|
|
23326
|
-
*
|
|
23327
|
-
*
|
|
23328
|
-
*
|
|
23329
|
-
*
|
|
23330
|
-
*
|
|
23331
|
-
* for metric blocks. Projections without backend support yet are empty;
|
|
23332
|
-
* `fact_table` is derivable from `InformationBlockEnvelope.facts`.
|
|
23329
|
+
* Two are computed at envelope-build time when their source data is
|
|
23330
|
+
* available: `rendering` (the rendered rows and periods) for the
|
|
23331
|
+
* statement family, disclosures, metrics, forecasts and reconciliations,
|
|
23332
|
+
* and `chart` (panel/series config over the rendering's rows and
|
|
23333
|
+
* periods) for metric blocks. The other views a client shows are
|
|
23334
|
+
* derived from the envelope itself — a fact table from
|
|
23335
|
+
* `InformationBlockEnvelope.facts`, rule outcomes from its rules and
|
|
23336
|
+
* verification results.
|
|
23333
23337
|
*/
|
|
23334
23338
|
export type ViewProjections = {
|
|
23335
23339
|
rendering?: RenderingLite | null;
|
|
@@ -23494,24 +23498,26 @@ export type CreateForecastArm = {
|
|
|
23494
23498
|
/**
|
|
23495
23499
|
* _CreateLegacyArm
|
|
23496
23500
|
*
|
|
23497
|
-
* Create-information-block body for block types
|
|
23498
|
-
*
|
|
23501
|
+
* Create-information-block body for block types constructed through
|
|
23502
|
+
* another operation.
|
|
23499
23503
|
*
|
|
23500
23504
|
* Statement-family blocks (balance_sheet, income_statement,
|
|
23501
23505
|
* cash_flow_statement, equity_statement, comprehensive_income) are
|
|
23502
23506
|
* constructed via `create-report`, not this endpoint. Disclosure
|
|
23503
23507
|
* structures (regulatory_disclosure) are vocabulary, authored via
|
|
23504
23508
|
* `create-taxonomy-block`; their facts land when `create-report`
|
|
23505
|
-
* picks them. Metric
|
|
23506
|
-
*
|
|
23507
|
-
*
|
|
23508
|
-
*
|
|
23509
|
+
* picks them. Metric structures are authored via
|
|
23510
|
+
* `create-taxonomy-block` and their facts written by `compute-metrics`
|
|
23511
|
+
* or `assert-metrics`. Reconciliation blocks are created by
|
|
23512
|
+
* `refresh-reconciliations`. Calling this endpoint with one of these
|
|
23513
|
+
* block types returns HTTP 501 with a hint pointing to the correct
|
|
23514
|
+
* construction path.
|
|
23509
23515
|
*/
|
|
23510
23516
|
export type CreateLegacyArm = {
|
|
23511
23517
|
/**
|
|
23512
23518
|
* Block Type
|
|
23513
23519
|
*
|
|
23514
|
-
* Statement-family
|
|
23520
|
+
* Statement-family, disclosure, metric or reconciliation block type. The endpoint returns 501 for these values with a hint naming the operation that constructs each.
|
|
23515
23521
|
*/
|
|
23516
23522
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
23517
23523
|
/**
|
|
@@ -23570,14 +23576,16 @@ export type DeleteForecastArm = {
|
|
|
23570
23576
|
* a typed delete path at the API boundary.
|
|
23571
23577
|
*
|
|
23572
23578
|
* Statement-family blocks cannot be deleted per tenant (the underlying
|
|
23573
|
-
* Report should be archived via the report APIs instead).
|
|
23574
|
-
*
|
|
23579
|
+
* Report should be archived via the report APIs instead). Disclosure
|
|
23580
|
+
* and metric structures are removed through the taxonomy-block
|
|
23581
|
+
* operations; a reconciliation stops holding the close through
|
|
23582
|
+
* `set-reconciliation-policy`. Calls return HTTP 501.
|
|
23575
23583
|
*/
|
|
23576
23584
|
export type DeleteLegacyArm = {
|
|
23577
23585
|
/**
|
|
23578
23586
|
* Block Type
|
|
23579
23587
|
*
|
|
23580
|
-
* Statement-family
|
|
23588
|
+
* 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.
|
|
23581
23589
|
*/
|
|
23582
23590
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
23583
23591
|
/**
|
|
@@ -23632,18 +23640,19 @@ export type UpdateForecastArm = {
|
|
|
23632
23640
|
/**
|
|
23633
23641
|
* _UpdateLegacyArm
|
|
23634
23642
|
*
|
|
23635
|
-
* Update-information-block body for block types
|
|
23636
|
-
*
|
|
23643
|
+
* Update-information-block body for block types updated through
|
|
23644
|
+
* another operation.
|
|
23637
23645
|
*
|
|
23638
|
-
* Statement-family blocks are library-seeded and immutable.
|
|
23639
|
-
*
|
|
23640
|
-
*
|
|
23646
|
+
* Statement-family blocks are library-seeded and immutable. Disclosure
|
|
23647
|
+
* and metric structures change through the taxonomy-block operations;
|
|
23648
|
+
* a reconciliation's policy through `set-reconciliation-policy`.
|
|
23649
|
+
* Calling this endpoint with one of these block types returns HTTP 501.
|
|
23641
23650
|
*/
|
|
23642
23651
|
export type UpdateLegacyArm = {
|
|
23643
23652
|
/**
|
|
23644
23653
|
* Block Type
|
|
23645
23654
|
*
|
|
23646
|
-
* Statement-family
|
|
23655
|
+
* 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.
|
|
23647
23656
|
*/
|
|
23648
23657
|
block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric' | 'reconciliation';
|
|
23649
23658
|
/**
|
|
@@ -26392,7 +26401,7 @@ export type GetOperatorMetadataData = {
|
|
|
26392
26401
|
/**
|
|
26393
26402
|
* Operator Type
|
|
26394
26403
|
*
|
|
26395
|
-
* Operator type identifier
|
|
26404
|
+
* Operator type identifier: 'analyst', 'mapping' or 'author'
|
|
26396
26405
|
*/
|
|
26397
26406
|
operator_type: string;
|
|
26398
26407
|
};
|