@robosystems/client 2.1.1 → 2.2.0

package/sdk/types.gen.d.ts

@@ -5317,19 +5317,27 @@ export type ExecuteEventBlockResponse = {
     /**
      * Status
      *
-     * Post-execute event status. `'classified'` when no write fired (native policy or no-op). `'committed'` when the QB write was in flight (intermediate state). `'fulfilled'` when QB accepted and local GL drafts were promoted to posted. `'pending'` when QB rejected — see `qb_error` for the rejection detail; retry after fixing the underlying issue.
+     * 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. `'pending'` when QuickBooks rejected an entry — see `qb_error`; retry after fixing the underlying issue.
      */
     status: string;
     /**
      * Qb External Id
      *
-     * QB-side transaction ID returned by the JournalEntry API. Null when no write fired (native policy) or when the write was rejected before getting an ID.
+     * QuickBooks JournalEntry ID of the first entry this call published. Null when nothing was published. When a call publishes several entries, `qb_entry_ids` holds them all.
      */
     qb_external_id?: string | null;
+    /**
+     * Qb Entry Ids
+     *
+     * Every entry of the event now in QuickBooks: ledger entry ID → QuickBooks JournalEntry ID. Null when none are.
+     */
+    qb_entry_ids?: {
+        [key: string]: string;
+    } | null;
     /**
      * Qb Error
      *
-     * QB rejection detail when status='pending'. Shape: `{code, message, qb_response_at}`. Operator retries after fixing CoA mapping / amount validation / closed-period.
+     * QB rejection detail when a publish failed. Shape: `{code, message, qb_response_at}`. Operator retries after fixing CoA mapping / amount validation / closed-period.
      */
     qb_error?: {
         [key: string]: unknown;
@@ -7186,7 +7194,7 @@ export type InformationBlockEnvelope = {
      */
     verification_summary?: VerificationSummary | null;
     /**
-     * Server-computed view projections (Charlie's six type-of View arms). `view.rendering` carries pre-computed rows + periods + validation for blocks where rendering is deterministic (the statement family today). Other projections come online as their backend support lands — see :class:`ViewProjections`.
+     * Server-computed view projections (the six `type-of` View projections). `view.rendering` carries pre-computed rows + periods + validation for blocks where rendering is deterministic (the statement family today). Projections without backend support yet are empty — see :class:`ViewProjections`.
      */
     view?: ViewProjections;
 };
@@ -9477,7 +9485,7 @@ export type OperationEnvelope = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9522,7 +9530,7 @@ export type OperationEnvelopeAssertMetricsResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9567,7 +9575,7 @@ export type OperationEnvelopeAssociationResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9612,7 +9620,7 @@ export type OperationEnvelopeBackfillPlanHistoryResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9657,7 +9665,7 @@ export type OperationEnvelopeBindTextBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9702,7 +9710,7 @@ export type OperationEnvelopeBlockSourceGraphResult = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9747,7 +9755,7 @@ export type OperationEnvelopeBlockedSourceGraphResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9792,7 +9800,7 @@ export type OperationEnvelopeChangeReportingStyleResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9837,7 +9845,7 @@ export type OperationEnvelopeClosePeriodResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9882,7 +9890,7 @@ export type OperationEnvelopeComputeForecastResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9927,7 +9935,7 @@ export type OperationEnvelopeComputeMetricsResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -9972,7 +9980,7 @@ export type OperationEnvelopeDeleteInformationBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10017,7 +10025,7 @@ export type OperationEnvelopeDeletePortfolioBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10062,7 +10070,7 @@ export type OperationEnvelopeDeleteResult = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10107,7 +10115,7 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10152,7 +10160,7 @@ export type OperationEnvelopeDisclosuresResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10197,7 +10205,7 @@ export type OperationEnvelopeEntityTaxonomyResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10242,7 +10250,7 @@ export type OperationEnvelopeEvaluateRulesResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10287,7 +10295,7 @@ export type OperationEnvelopeEventBlockEnvelope = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10332,7 +10340,7 @@ export type OperationEnvelopeEventHandlerResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10377,7 +10385,7 @@ export type OperationEnvelopeExecuteEventBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10422,7 +10430,7 @@ export type OperationEnvelopeFinancialStatementAnalysisResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10467,7 +10475,7 @@ export type OperationEnvelopeFiscalCalendarResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10512,7 +10520,7 @@ export type OperationEnvelopeGraphMetadataResult = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10557,7 +10565,7 @@ export type OperationEnvelopeInformationBlockEnvelope = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10602,7 +10610,7 @@ export type OperationEnvelopeInformationBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10647,7 +10655,7 @@ export type OperationEnvelopeInitializeChartOfAccountsResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10692,7 +10700,7 @@ export type OperationEnvelopeInitializeLedgerResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10737,7 +10745,7 @@ export type OperationEnvelopeJournalEntryResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10782,7 +10790,7 @@ export type OperationEnvelopeLedgerAgentResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10827,7 +10835,7 @@ export type OperationEnvelopeLedgerEntityResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10872,7 +10880,7 @@ export type OperationEnvelopeLiveFinancialStatementResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10917,7 +10925,7 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -10962,7 +10970,7 @@ export type OperationEnvelopePreviewEventBlockResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11007,7 +11015,7 @@ export type OperationEnvelopePromoteObligationsResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11052,7 +11060,7 @@ export type OperationEnvelopePublishListResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11097,7 +11105,7 @@ export type OperationEnvelopeReconcilingItemPlan = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11142,7 +11150,7 @@ export type OperationEnvelopeReportResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11187,7 +11195,7 @@ export type OperationEnvelopeResolveReconcilingItemResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11232,7 +11240,7 @@ export type OperationEnvelopeRevokeReportShareResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11277,7 +11285,7 @@ export type OperationEnvelopeScheduleCreatedResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11322,7 +11330,7 @@ export type OperationEnvelopeSecurityResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11367,7 +11375,7 @@ export type OperationEnvelopeShareReportResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11412,7 +11420,7 @@ export type OperationEnvelopeTaxonomyBlockEnvelope = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11457,7 +11465,7 @@ export type OperationEnvelopeTerminateScheduleResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11502,7 +11510,7 @@ export type OperationEnvelopeViewResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -11549,7 +11557,7 @@ export type OperationEnvelopeListPublishListMemberResponse = {
     /**
      * Createdby
      *
-     * User ID that initiated the operation (null for legacy callers)
+     * User ID that initiated the operation
      */
     createdBy?: string | null;
     /**
@@ -14409,7 +14417,7 @@ export type RuleLite = {
     /**
      * Rule Origin
      *
-     * Provenance — 'forked' (from an upstream artifact, e.g. Seattle Method) or 'native' (authored in this seed or by a tenant). Enum closure enforced by the `public.rules` CHECK constraint.
+     * Provenance — 'forked' (from an upstream artifact, e.g. an external XBRL taxonomy) or 'native' (authored in this seed or by a tenant). Enum closure enforced by the `public.rules` CHECK constraint.
      */
     rule_origin?: string;
 };
@@ -14633,7 +14641,7 @@ export type ScheduleMetadataRequest = {
     /**
      * Residual Value
      *
-     * Salvage value in cents
+     * Salvage value in cents. The schedule expenses `original_amount` less this; net book value ends at it.
      */
     residual_value?: number;
     /**
@@ -14651,7 +14659,7 @@ export type ScheduleMetadataRequest = {
     /**
      * Periodic Amounts
      *
-     * Explicit per-period amounts in cents. When set, the generator uses these values instead of `monthly_amount` — enabling non-straight-line schedules (effective-interest bond discount amortization, day-count interest accrual, variable lease payments, pre-computed effective-yield curves, etc.). Length must match the number of monthly periods between `period_start` and `period_end`; sum must equal `original_amount` exactly. The auto-generated SumEquals rule proves Σ = original regardless of the curve shape.
+     * Explicit per-period amounts in cents. When set, the generator uses these values instead of `monthly_amount` — enabling non-straight-line schedules (effective-interest bond discount amortization, day-count interest accrual, variable lease payments, pre-computed effective-yield curves, etc.). Length must match the number of monthly periods between `period_start` and `period_end`; sum must equal `original_amount` less `residual_value` exactly. The auto-generated SumEquals rule proves that total regardless of the curve shape.
      */
     periodic_amounts?: Array<number> | null;
 };
@@ -18114,22 +18122,20 @@ export type ViewMetadata = {
 /**
  * ViewProjections
  *
- * Charlie's six `type-of View` arms, surfaced at the envelope boundary.
+ * The six `type-of` View projections of an Information Block (Rendering,
+ * FactTable, ModelStructure, VerificationResults, ReportElements,
+ * BusinessRules), surfaced at the envelope boundary.
  *
  * Each projection is computed server-side at envelope-build time when
  * its source data is available. The frontend's `BlockView` dispatcher
  * routes to the projection component matching the user's selected view
- * mode; missing projections (those still in backlog) render as empty
- * states without breaking the dispatcher.
+ * mode; missing projections render as empty states without breaking the
+ * dispatcher.
  *
  * Today: `rendering` is computed for the statement family, and
- * `chart` (the 7th arm — panel/series config over the rendering's
- * rows and periods) for metric blocks.
- * Other arms (`fact_table`, `model_structure`, `verification_results`,
- * `report_elements`, `business_rules`) come online as their backend
- * support lands; `fact_table` is trivially derivable from
- * `InformationBlockEnvelope.facts` and may stay as a frontend-only
- * projection.
+ * `chart` (panel/series config over the rendering's rows and periods)
+ * for metric blocks. Projections without backend support yet are empty;
+ * `fact_table` is derivable from `InformationBlockEnvelope.facts`.
  */
 export type ViewProjections = {
     rendering?: RenderingLite | null;