@robosystems/client 2.19.0 → 2.20.1

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.
@@ -252,6 +252,13 @@ export interface ClosePeriodOptions extends EntityScopeOptions {
252
252
  * recorded in the close audit note.
253
253
  */
254
254
  allowUnreconciledAccounts?: boolean;
255
+ /**
256
+ * On the consolidation entity, whose close is the group's: close despite a
257
+ * residual or intercompany disagreement left unexplained. Its difference
258
+ * stays in the consolidated statements and each item is named in the
259
+ * close audit note.
260
+ */
261
+ allowUnexplainedResiduals?: boolean;
255
262
  /**
256
263
  * Close despite posted events whose source payload changed afterwards and
257
264
  * that nobody has decided on. Prefer `resolveReconcilingItem` on each.
@@ -771,6 +771,7 @@ class LedgerClient {
771
771
  allow_unreconciled_accounts: options?.allowUnreconciledAccounts,
772
772
  allow_reconciling_items: options?.allowReconcilingItems,
773
773
  allow_unposted_source_events: options?.allowUnpostedSourceEvents,
774
+ allow_unexplained_residuals: options?.allowUnexplainedResiduals,
774
775
  };
775
776
  const envelope = await this.callOperation('Close period', (o) => (0, sdk_gen_1.closePeriod)({ ...o, path: { graph_id: graphId }, body }));
776
777
  const raw = envelope.result;
@@ -1599,6 +1600,10 @@ function rawFiscalCalendarToCamel(raw) {
1599
1600
  unpostedSourceEventSample: raw.unposted_source_event_sample ?? [],
1600
1601
  unreconciledAccountCount: raw.unreconciled_account_count ?? 0,
1601
1602
  unreconciledAccountSample: raw.unreconciled_account_sample ?? [],
1603
+ groupOpenEntities: raw.group_open_entities ?? [],
1604
+ groupPendingAdjustments: raw.group_pending_adjustments ?? [],
1605
+ groupUnexplained: raw.group_unexplained ?? [],
1606
+ groupNotFooting: raw.group_not_footing ?? [],
1602
1607
  lastCloseAt: raw.last_close_at ?? null,
1603
1608
  initializedAt: raw.initialized_at ?? null,
1604
1609
  lastSyncAt: raw.last_sync_at ?? null,
@@ -503,6 +503,10 @@ interface RawFiscalCalendar {
503
503
  unposted_source_event_sample?: string[]
504
504
  unreconciled_account_count?: number
505
505
  unreconciled_account_sample?: string[]
506
+ group_open_entities?: string[]
507
+ group_pending_adjustments?: string[]
508
+ group_unexplained?: string[]
509
+ group_not_footing?: string[]
506
510
  last_close_at: string | null
507
511
  initialized_at: string | null
508
512
  last_sync_at: string | null
@@ -693,6 +697,13 @@ export interface ClosePeriodOptions extends EntityScopeOptions {
693
697
  * recorded in the close audit note.
694
698
  */
695
699
  allowUnreconciledAccounts?: boolean
700
+ /**
701
+ * On the consolidation entity, whose close is the group's: close despite a
702
+ * residual or intercompany disagreement left unexplained. Its difference
703
+ * stays in the consolidated statements and each item is named in the
704
+ * close audit note.
705
+ */
706
+ allowUnexplainedResiduals?: boolean
696
707
  /**
697
708
  * Close despite posted events whose source payload changed afterwards and
698
709
  * that nobody has decided on. Prefer `resolveReconcilingItem` on each.
@@ -2223,6 +2234,7 @@ export class LedgerClient {
2223
2234
  allow_unreconciled_accounts: options?.allowUnreconciledAccounts,
2224
2235
  allow_reconciling_items: options?.allowReconcilingItems,
2225
2236
  allow_unposted_source_events: options?.allowUnpostedSourceEvents,
2237
+ allow_unexplained_residuals: options?.allowUnexplainedResiduals,
2226
2238
  }
2227
2239
  const envelope = await this.callOperation('Close period', (o) =>
2228
2240
  closePeriod({ ...o, path: { graph_id: graphId }, body })
@@ -3441,6 +3453,10 @@ function rawFiscalCalendarToCamel(raw: RawFiscalCalendar): LedgerFiscalCalendar
3441
3453
  unpostedSourceEventSample: raw.unposted_source_event_sample ?? [],
3442
3454
  unreconciledAccountCount: raw.unreconciled_account_count ?? 0,
3443
3455
  unreconciledAccountSample: raw.unreconciled_account_sample ?? [],
3456
+ groupOpenEntities: raw.group_open_entities ?? [],
3457
+ groupPendingAdjustments: raw.group_pending_adjustments ?? [],
3458
+ groupUnexplained: raw.group_unexplained ?? [],
3459
+ groupNotFooting: raw.group_not_footing ?? [],
3444
3460
  lastCloseAt: raw.last_close_at ?? null,
3445
3461
  initializedAt: raw.initialized_at ?? null,
3446
3462
  lastSyncAt: raw.last_sync_at ?? null,
@@ -724,6 +724,10 @@ export type GetLedgerFiscalCalendarQuery = {
724
724
  unpostedSourceEventSample: Array<string>;
725
725
  unreconciledAccountCount: number;
726
726
  unreconciledAccountSample: Array<string>;
727
+ groupOpenEntities: Array<string>;
728
+ groupPendingAdjustments: Array<string>;
729
+ groupUnexplained: Array<string>;
730
+ groupNotFooting: Array<string>;
727
731
  lastCloseAt: string | null;
728
732
  initializedAt: string | null;
729
733
  lastSyncAt: string | null;
@@ -2054,6 +2054,10 @@ exports.GetLedgerFiscalCalendarDocument = {
2054
2054
  { kind: 'Field', name: { kind: 'Name', value: 'unpostedSourceEventSample' } },
2055
2055
  { kind: 'Field', name: { kind: 'Name', value: 'unreconciledAccountCount' } },
2056
2056
  { kind: 'Field', name: { kind: 'Name', value: 'unreconciledAccountSample' } },
2057
+ { kind: 'Field', name: { kind: 'Name', value: 'groupOpenEntities' } },
2058
+ { kind: 'Field', name: { kind: 'Name', value: 'groupPendingAdjustments' } },
2059
+ { kind: 'Field', name: { kind: 'Name', value: 'groupUnexplained' } },
2060
+ { kind: 'Field', name: { kind: 'Name', value: 'groupNotFooting' } },
2057
2061
  { kind: 'Field', name: { kind: 'Name', value: 'lastCloseAt' } },
2058
2062
  { kind: 'Field', name: { kind: 'Name', value: 'initializedAt' } },
2059
2063
  { kind: 'Field', name: { kind: 'Name', value: 'lastSyncAt' } },
@@ -726,6 +726,10 @@ export type GetLedgerFiscalCalendarQuery = {
726
726
  unpostedSourceEventSample: Array<string>
727
727
  unreconciledAccountCount: number
728
728
  unreconciledAccountSample: Array<string>
729
+ groupOpenEntities: Array<string>
730
+ groupPendingAdjustments: Array<string>
731
+ groupUnexplained: Array<string>
732
+ groupNotFooting: Array<string>
729
733
  lastCloseAt: string | null
730
734
  initializedAt: string | null
731
735
  lastSyncAt: string | null
@@ -4358,6 +4362,10 @@ export const GetLedgerFiscalCalendarDocument = {
4358
4362
  { kind: 'Field', name: { kind: 'Name', value: 'unpostedSourceEventSample' } },
4359
4363
  { kind: 'Field', name: { kind: 'Name', value: 'unreconciledAccountCount' } },
4360
4364
  { kind: 'Field', name: { kind: 'Name', value: 'unreconciledAccountSample' } },
4365
+ { kind: 'Field', name: { kind: 'Name', value: 'groupOpenEntities' } },
4366
+ { kind: 'Field', name: { kind: 'Name', value: 'groupPendingAdjustments' } },
4367
+ { kind: 'Field', name: { kind: 'Name', value: 'groupUnexplained' } },
4368
+ { kind: 'Field', name: { kind: 'Name', value: 'groupNotFooting' } },
4361
4369
  { kind: 'Field', name: { kind: 'Name', value: 'lastCloseAt' } },
4362
4370
  { kind: 'Field', name: { kind: 'Name', value: 'initializedAt' } },
4363
4371
  { kind: 'Field', name: { kind: 'Name', value: 'lastSyncAt' } },
@@ -50,6 +50,10 @@ exports.GET_FISCAL_CALENDAR = (0, graphql_request_1.gql) `
50
50
  unpostedSourceEventSample
51
51
  unreconciledAccountCount
52
52
  unreconciledAccountSample
53
+ groupOpenEntities
54
+ groupPendingAdjustments
55
+ groupUnexplained
56
+ groupNotFooting
53
57
  lastCloseAt
54
58
  initializedAt
55
59
  lastSyncAt
@@ -48,6 +48,10 @@ export const GET_FISCAL_CALENDAR = gql`
48
48
  unpostedSourceEventSample
49
49
  unreconciledAccountCount
50
50
  unreconciledAccountSample
51
+ groupOpenEntities
52
+ groupPendingAdjustments
53
+ groupUnexplained
54
+ groupNotFooting
51
55
  lastCloseAt
52
56
  initializedAt
53
57
  lastSyncAt
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.19.0",
3
+ "version": "2.20.1",
4
4
  "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/sdk/sdk.gen.d.ts CHANGED
@@ -926,7 +926,7 @@ export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>
926
926
  /**
927
927
  * Link Entity to Taxonomy
928
928
  *
929
- * Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.
929
+ * Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
930
930
  *
931
931
  * **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.
932
932
  */
package/sdk/sdk.gen.js CHANGED
@@ -1892,7 +1892,7 @@ exports.deleteTaxonomyBlock = deleteTaxonomyBlock;
1892
1892
  /**
1893
1893
  * Link Entity to Taxonomy
1894
1894
  *
1895
- * Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.
1895
+ * Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
1896
1896
  *
1897
1897
  * **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.
1898
1898
  */
package/sdk/sdk.gen.ts CHANGED
@@ -1903,7 +1903,7 @@ export const deleteTaxonomyBlock = <ThrowOnError extends boolean = false>(option
1903
1903
  /**
1904
1904
  * Link Entity to Taxonomy
1905
1905
  *
1906
- * Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.
1906
+ * Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
1907
1907
  *
1908
1908
  * **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.
1909
1909
  */
@@ -1002,6 +1002,12 @@ export type BackfillPlanHistoryOperation = {
1002
1002
  * Override the reconciliation gate on each reclose. Needed when a month inside the backfill window has a reconciliation the close waits on that was never compared for it, which is every month closed before the reconciliation existed.
1003
1003
  */
1004
1004
  allow_unreconciled_accounts?: boolean;
1005
+ /**
1006
+ * Allow Unexplained Residuals
1007
+ *
1008
+ * Override the group close's residual gate on each reclose of the consolidation entity's months.
1009
+ */
1010
+ allow_unexplained_residuals?: boolean;
1005
1011
  /**
1006
1012
  * Restamp
1007
1013
  *
@@ -2001,6 +2007,12 @@ export type ClosePeriodOperation = {
2001
2007
  * Override the reconciliation gate — close even though a reconciliation the close waits on is not reconciled for the period, or was never compared for it. The books are then closed without that check. Prefer refresh-reconciliations and clearing what it reports first. The override is recorded in the close audit note.
2002
2008
  */
2003
2009
  allow_unreconciled_accounts?: boolean;
2010
+ /**
2011
+ * Allow Unexplained Residuals
2012
+ *
2013
+ * On the consolidation entity, the group close: close even though a residual or an intercompany disagreement is left unexplained. Its difference stays in the consolidated statements. Prefer correcting the books or posting the explaining entry with its basis. The override, and each item it closed over, is recorded in the close audit note.
2014
+ */
2015
+ allow_unexplained_residuals?: boolean;
2004
2016
  /**
2005
2017
  * Period
2006
2018
  *
@@ -6983,7 +6995,7 @@ export type FiscalCalendarResponse = {
6983
6995
  /**
6984
6996
  * Blockers
6985
6997
  *
6986
- * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'
6998
+ * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
6987
6999
  */
6988
7000
  blockers?: Array<string>;
6989
7001
  /**
@@ -7058,6 +7070,30 @@ export type FiscalCalendarResponse = {
7058
7070
  * Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
7059
7071
  */
7060
7072
  unreconciled_account_sample?: Array<string>;
7073
+ /**
7074
+ * Group Open Entities
7075
+ *
7076
+ * The group close: the entities the month consolidates, the parent and its equity-method members included, that have not closed it. Close each first.
7077
+ */
7078
+ group_open_entities?: Array<string>;
7079
+ /**
7080
+ * Group Pending Adjustments
7081
+ *
7082
+ * The group close: the consolidating entries the consolidation entity neither holds nor has drafted, by kind and member, or what the engine left out and why. Run propose-consolidation-entries.
7083
+ */
7084
+ group_pending_adjustments?: Array<string>;
7085
+ /**
7086
+ * Group Unexplained
7087
+ *
7088
+ * The group close: residuals and intercompany disagreements left unexplained. Correct the books or post the explaining entry, or close over them knowingly with allow_unexplained_residuals.
7089
+ */
7090
+ group_unexplained?: Array<string>;
7091
+ /**
7092
+ * Group Not Footing
7093
+ *
7094
+ * The group close: the consolidated balance sheet's and equity statement's validation failures for the month.
7095
+ */
7096
+ group_not_footing?: Array<string>;
7061
7097
  /**
7062
7098
  * Last Close At
7063
7099
  */
@@ -9978,14 +10014,12 @@ export type LinkBankAccountResponse = {
9978
10014
  *
9979
10015
  * Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
9980
10016
  *
9981
- * This is how a graph declares "this entity reports under this taxonomy."
9982
- * For `chart_of_accounts` taxonomies, this tells the platform which CoA
9983
- * the entity uses. For reporting taxonomies, which standard (us-gaap,
9984
- * ifrs). Idempotent — re-linking returns the existing edge unchanged.
9985
- *
9986
- * CoA blocks auto-link at create time; use this to switch the primary
9987
- * CoA, link a reporting extension, or attach a custom ontology
9988
- * explicitly.
10017
+ * A `chart_of_accounts` link tells the platform which chart the entity
10018
+ * keeps its books in; CoA blocks auto-link at create time, so use this to
10019
+ * switch the primary one. The other bases record the association and
10020
+ * nothing reads them: statements render from the entity's reporting style,
10021
+ * whatever taxonomy is linked. Idempotent — re-linking returns the
10022
+ * existing edge unchanged.
9989
10023
  */
9990
10024
  export type LinkEntityTaxonomyRequest = {
9991
10025
  /**
@@ -10003,7 +10037,7 @@ export type LinkEntityTaxonomyRequest = {
10003
10037
  /**
10004
10038
  * Basis
10005
10039
  *
10006
- * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard like us-gaap), `mapping` (CoA→reporting rollup), `schedule` (schedule structure).
10040
+ * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
10007
10041
  */
10008
10042
  basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
10009
10043
  /**
@@ -15415,7 +15449,7 @@ export type PreviewConsolidationEntriesResponse = {
15415
15449
  /**
15416
15450
  * Up To Date
15417
15451
  *
15418
- * True when nothing is proposed, withheld or left out: the consolidation entity already holds what the month needs. A closed month is up to date as posted; read `closed` first.
15452
+ * True when nothing is withheld or left out and the consolidation entity holds what the month needs, posted or in the month's drafts (then `proposals` lists what the drafts hold). A closed month is up to date as posted; read `closed` first.
15419
15453
  */
15420
15454
  up_to_date: boolean;
15421
15455
  /**
@@ -15424,6 +15458,12 @@ export type PreviewConsolidationEntriesResponse = {
15424
15458
  * True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
15425
15459
  */
15426
15460
  closed?: boolean;
15461
+ /**
15462
+ * Incomplete
15463
+ *
15464
+ * True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
15465
+ */
15466
+ incomplete?: boolean;
15427
15467
  /**
15428
15468
  * Drafted Entry Ids
15429
15469
  *
package/sdk/types.gen.ts CHANGED
@@ -1029,6 +1029,12 @@ export type BackfillPlanHistoryOperation = {
1029
1029
  * Override the reconciliation gate on each reclose. Needed when a month inside the backfill window has a reconciliation the close waits on that was never compared for it, which is every month closed before the reconciliation existed.
1030
1030
  */
1031
1031
  allow_unreconciled_accounts?: boolean;
1032
+ /**
1033
+ * Allow Unexplained Residuals
1034
+ *
1035
+ * Override the group close's residual gate on each reclose of the consolidation entity's months.
1036
+ */
1037
+ allow_unexplained_residuals?: boolean;
1032
1038
  /**
1033
1039
  * Restamp
1034
1040
  *
@@ -2055,6 +2061,12 @@ export type ClosePeriodOperation = {
2055
2061
  * Override the reconciliation gate — close even though a reconciliation the close waits on is not reconciled for the period, or was never compared for it. The books are then closed without that check. Prefer refresh-reconciliations and clearing what it reports first. The override is recorded in the close audit note.
2056
2062
  */
2057
2063
  allow_unreconciled_accounts?: boolean;
2064
+ /**
2065
+ * Allow Unexplained Residuals
2066
+ *
2067
+ * On the consolidation entity, the group close: close even though a residual or an intercompany disagreement is left unexplained. Its difference stays in the consolidated statements. Prefer correcting the books or posting the explaining entry with its basis. The override, and each item it closed over, is recorded in the close audit note.
2068
+ */
2069
+ allow_unexplained_residuals?: boolean;
2058
2070
  /**
2059
2071
  * Period
2060
2072
  *
@@ -7151,7 +7163,7 @@ export type FiscalCalendarResponse = {
7151
7163
  /**
7152
7164
  * Blockers
7153
7165
  *
7154
- * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'
7166
+ * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7155
7167
  */
7156
7168
  blockers?: Array<string>;
7157
7169
  /**
@@ -7226,6 +7238,30 @@ export type FiscalCalendarResponse = {
7226
7238
  * Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
7227
7239
  */
7228
7240
  unreconciled_account_sample?: Array<string>;
7241
+ /**
7242
+ * Group Open Entities
7243
+ *
7244
+ * The group close: the entities the month consolidates, the parent and its equity-method members included, that have not closed it. Close each first.
7245
+ */
7246
+ group_open_entities?: Array<string>;
7247
+ /**
7248
+ * Group Pending Adjustments
7249
+ *
7250
+ * The group close: the consolidating entries the consolidation entity neither holds nor has drafted, by kind and member, or what the engine left out and why. Run propose-consolidation-entries.
7251
+ */
7252
+ group_pending_adjustments?: Array<string>;
7253
+ /**
7254
+ * Group Unexplained
7255
+ *
7256
+ * The group close: residuals and intercompany disagreements left unexplained. Correct the books or post the explaining entry, or close over them knowingly with allow_unexplained_residuals.
7257
+ */
7258
+ group_unexplained?: Array<string>;
7259
+ /**
7260
+ * Group Not Footing
7261
+ *
7262
+ * The group close: the consolidated balance sheet's and equity statement's validation failures for the month.
7263
+ */
7264
+ group_not_footing?: Array<string>;
7229
7265
  /**
7230
7266
  * Last Close At
7231
7267
  */
@@ -10206,14 +10242,12 @@ export type LinkBankAccountResponse = {
10206
10242
  *
10207
10243
  * Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
10208
10244
  *
10209
- * This is how a graph declares "this entity reports under this taxonomy."
10210
- * For `chart_of_accounts` taxonomies, this tells the platform which CoA
10211
- * the entity uses. For reporting taxonomies, which standard (us-gaap,
10212
- * ifrs). Idempotent — re-linking returns the existing edge unchanged.
10213
- *
10214
- * CoA blocks auto-link at create time; use this to switch the primary
10215
- * CoA, link a reporting extension, or attach a custom ontology
10216
- * explicitly.
10245
+ * A `chart_of_accounts` link tells the platform which chart the entity
10246
+ * keeps its books in; CoA blocks auto-link at create time, so use this to
10247
+ * switch the primary one. The other bases record the association and
10248
+ * nothing reads them: statements render from the entity's reporting style,
10249
+ * whatever taxonomy is linked. Idempotent — re-linking returns the
10250
+ * existing edge unchanged.
10217
10251
  */
10218
10252
  export type LinkEntityTaxonomyRequest = {
10219
10253
  /**
@@ -10231,7 +10265,7 @@ export type LinkEntityTaxonomyRequest = {
10231
10265
  /**
10232
10266
  * Basis
10233
10267
  *
10234
- * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard like us-gaap), `mapping` (CoA→reporting rollup), `schedule` (schedule structure).
10268
+ * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
10235
10269
  */
10236
10270
  basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
10237
10271
  /**
@@ -15778,7 +15812,7 @@ export type PreviewConsolidationEntriesResponse = {
15778
15812
  /**
15779
15813
  * Up To Date
15780
15814
  *
15781
- * True when nothing is proposed, withheld or left out: the consolidation entity already holds what the month needs. A closed month is up to date as posted; read `closed` first.
15815
+ * True when nothing is withheld or left out and the consolidation entity holds what the month needs, posted or in the month's drafts (then `proposals` lists what the drafts hold). A closed month is up to date as posted; read `closed` first.
15782
15816
  */
15783
15817
  up_to_date: boolean;
15784
15818
  /**
@@ -15787,6 +15821,12 @@ export type PreviewConsolidationEntriesResponse = {
15787
15821
  * True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
15788
15822
  */
15789
15823
  closed?: boolean;
15824
+ /**
15825
+ * Incomplete
15826
+ *
15827
+ * True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
15828
+ */
15829
+ incomplete?: boolean;
15790
15830
  /**
15791
15831
  * Drafted Entry Ids
15792
15832
  *
package/sdk.gen.d.ts CHANGED
@@ -926,7 +926,7 @@ export declare const deleteTaxonomyBlock: <ThrowOnError extends boolean = false>
926
926
  /**
927
927
  * Link Entity to Taxonomy
928
928
  *
929
- * Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.
929
+ * Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
930
930
  *
931
931
  * **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.
932
932
  */
package/sdk.gen.js CHANGED
@@ -1892,7 +1892,7 @@ exports.deleteTaxonomyBlock = deleteTaxonomyBlock;
1892
1892
  /**
1893
1893
  * Link Entity to Taxonomy
1894
1894
  *
1895
- * Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.
1895
+ * Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
1896
1896
  *
1897
1897
  * **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.
1898
1898
  */
package/sdk.gen.ts CHANGED
@@ -1903,7 +1903,7 @@ export const deleteTaxonomyBlock = <ThrowOnError extends boolean = false>(option
1903
1903
  /**
1904
1904
  * Link Entity to Taxonomy
1905
1905
  *
1906
- * Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.
1906
+ * Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the `chart_of_accounts` basis changes behavior: a `reporting`, `mapping` or `schedule` link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.
1907
1907
  *
1908
1908
  * **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.
1909
1909
  */
package/types.gen.d.ts CHANGED
@@ -1002,6 +1002,12 @@ export type BackfillPlanHistoryOperation = {
1002
1002
  * Override the reconciliation gate on each reclose. Needed when a month inside the backfill window has a reconciliation the close waits on that was never compared for it, which is every month closed before the reconciliation existed.
1003
1003
  */
1004
1004
  allow_unreconciled_accounts?: boolean;
1005
+ /**
1006
+ * Allow Unexplained Residuals
1007
+ *
1008
+ * Override the group close's residual gate on each reclose of the consolidation entity's months.
1009
+ */
1010
+ allow_unexplained_residuals?: boolean;
1005
1011
  /**
1006
1012
  * Restamp
1007
1013
  *
@@ -2001,6 +2007,12 @@ export type ClosePeriodOperation = {
2001
2007
  * Override the reconciliation gate — close even though a reconciliation the close waits on is not reconciled for the period, or was never compared for it. The books are then closed without that check. Prefer refresh-reconciliations and clearing what it reports first. The override is recorded in the close audit note.
2002
2008
  */
2003
2009
  allow_unreconciled_accounts?: boolean;
2010
+ /**
2011
+ * Allow Unexplained Residuals
2012
+ *
2013
+ * On the consolidation entity, the group close: close even though a residual or an intercompany disagreement is left unexplained. Its difference stays in the consolidated statements. Prefer correcting the books or posting the explaining entry with its basis. The override, and each item it closed over, is recorded in the close audit note.
2014
+ */
2015
+ allow_unexplained_residuals?: boolean;
2004
2016
  /**
2005
2017
  * Period
2006
2018
  *
@@ -6983,7 +6995,7 @@ export type FiscalCalendarResponse = {
6983
6995
  /**
6984
6996
  * Blockers
6985
6997
  *
6986
- * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'
6998
+ * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
6987
6999
  */
6988
7000
  blockers?: Array<string>;
6989
7001
  /**
@@ -7058,6 +7070,30 @@ export type FiscalCalendarResponse = {
7058
7070
  * Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
7059
7071
  */
7060
7072
  unreconciled_account_sample?: Array<string>;
7073
+ /**
7074
+ * Group Open Entities
7075
+ *
7076
+ * The group close: the entities the month consolidates, the parent and its equity-method members included, that have not closed it. Close each first.
7077
+ */
7078
+ group_open_entities?: Array<string>;
7079
+ /**
7080
+ * Group Pending Adjustments
7081
+ *
7082
+ * The group close: the consolidating entries the consolidation entity neither holds nor has drafted, by kind and member, or what the engine left out and why. Run propose-consolidation-entries.
7083
+ */
7084
+ group_pending_adjustments?: Array<string>;
7085
+ /**
7086
+ * Group Unexplained
7087
+ *
7088
+ * The group close: residuals and intercompany disagreements left unexplained. Correct the books or post the explaining entry, or close over them knowingly with allow_unexplained_residuals.
7089
+ */
7090
+ group_unexplained?: Array<string>;
7091
+ /**
7092
+ * Group Not Footing
7093
+ *
7094
+ * The group close: the consolidated balance sheet's and equity statement's validation failures for the month.
7095
+ */
7096
+ group_not_footing?: Array<string>;
7061
7097
  /**
7062
7098
  * Last Close At
7063
7099
  */
@@ -9978,14 +10014,12 @@ export type LinkBankAccountResponse = {
9978
10014
  *
9979
10015
  * Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
9980
10016
  *
9981
- * This is how a graph declares "this entity reports under this taxonomy."
9982
- * For `chart_of_accounts` taxonomies, this tells the platform which CoA
9983
- * the entity uses. For reporting taxonomies, which standard (us-gaap,
9984
- * ifrs). Idempotent — re-linking returns the existing edge unchanged.
9985
- *
9986
- * CoA blocks auto-link at create time; use this to switch the primary
9987
- * CoA, link a reporting extension, or attach a custom ontology
9988
- * explicitly.
10017
+ * A `chart_of_accounts` link tells the platform which chart the entity
10018
+ * keeps its books in; CoA blocks auto-link at create time, so use this to
10019
+ * switch the primary one. The other bases record the association and
10020
+ * nothing reads them: statements render from the entity's reporting style,
10021
+ * whatever taxonomy is linked. Idempotent — re-linking returns the
10022
+ * existing edge unchanged.
9989
10023
  */
9990
10024
  export type LinkEntityTaxonomyRequest = {
9991
10025
  /**
@@ -10003,7 +10037,7 @@ export type LinkEntityTaxonomyRequest = {
10003
10037
  /**
10004
10038
  * Basis
10005
10039
  *
10006
- * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard like us-gaap), `mapping` (CoA→reporting rollup), `schedule` (schedule structure).
10040
+ * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
10007
10041
  */
10008
10042
  basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
10009
10043
  /**
@@ -15415,7 +15449,7 @@ export type PreviewConsolidationEntriesResponse = {
15415
15449
  /**
15416
15450
  * Up To Date
15417
15451
  *
15418
- * True when nothing is proposed, withheld or left out: the consolidation entity already holds what the month needs. A closed month is up to date as posted; read `closed` first.
15452
+ * True when nothing is withheld or left out and the consolidation entity holds what the month needs, posted or in the month's drafts (then `proposals` lists what the drafts hold). A closed month is up to date as posted; read `closed` first.
15419
15453
  */
15420
15454
  up_to_date: boolean;
15421
15455
  /**
@@ -15424,6 +15458,12 @@ export type PreviewConsolidationEntriesResponse = {
15424
15458
  * True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
15425
15459
  */
15426
15460
  closed?: boolean;
15461
+ /**
15462
+ * Incomplete
15463
+ *
15464
+ * True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
15465
+ */
15466
+ incomplete?: boolean;
15427
15467
  /**
15428
15468
  * Drafted Entry Ids
15429
15469
  *
package/types.gen.ts CHANGED
@@ -1029,6 +1029,12 @@ export type BackfillPlanHistoryOperation = {
1029
1029
  * Override the reconciliation gate on each reclose. Needed when a month inside the backfill window has a reconciliation the close waits on that was never compared for it, which is every month closed before the reconciliation existed.
1030
1030
  */
1031
1031
  allow_unreconciled_accounts?: boolean;
1032
+ /**
1033
+ * Allow Unexplained Residuals
1034
+ *
1035
+ * Override the group close's residual gate on each reclose of the consolidation entity's months.
1036
+ */
1037
+ allow_unexplained_residuals?: boolean;
1032
1038
  /**
1033
1039
  * Restamp
1034
1040
  *
@@ -2055,6 +2061,12 @@ export type ClosePeriodOperation = {
2055
2061
  * Override the reconciliation gate — close even though a reconciliation the close waits on is not reconciled for the period, or was never compared for it. The books are then closed without that check. Prefer refresh-reconciliations and clearing what it reports first. The override is recorded in the close audit note.
2056
2062
  */
2057
2063
  allow_unreconciled_accounts?: boolean;
2064
+ /**
2065
+ * Allow Unexplained Residuals
2066
+ *
2067
+ * On the consolidation entity, the group close: close even though a residual or an intercompany disagreement is left unexplained. Its difference stays in the consolidated statements. Prefer correcting the books or posting the explaining entry with its basis. The override, and each item it closed over, is recorded in the close audit note.
2068
+ */
2069
+ allow_unexplained_residuals?: boolean;
2058
2070
  /**
2059
2071
  * Period
2060
2072
  *
@@ -7151,7 +7163,7 @@ export type FiscalCalendarResponse = {
7151
7163
  /**
7152
7164
  * Blockers
7153
7165
  *
7154
- * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'
7166
+ * Structured blocker codes when closeable_now is False: 'sequence_violation', 'period_incomplete', 'sync_stale', 'calendar_not_initialized', 'period_already_closed', 'pending_obligations', 'stranded_obligations', 'reconciling_items', 'unposted_source_events', 'unreconciled_accounts'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7155
7167
  */
7156
7168
  blockers?: Array<string>;
7157
7169
  /**
@@ -7226,6 +7238,30 @@ export type FiscalCalendarResponse = {
7226
7238
  * Name and status of up to 5 of those reconciliations, so the blocker names what is holding the close.
7227
7239
  */
7228
7240
  unreconciled_account_sample?: Array<string>;
7241
+ /**
7242
+ * Group Open Entities
7243
+ *
7244
+ * The group close: the entities the month consolidates, the parent and its equity-method members included, that have not closed it. Close each first.
7245
+ */
7246
+ group_open_entities?: Array<string>;
7247
+ /**
7248
+ * Group Pending Adjustments
7249
+ *
7250
+ * The group close: the consolidating entries the consolidation entity neither holds nor has drafted, by kind and member, or what the engine left out and why. Run propose-consolidation-entries.
7251
+ */
7252
+ group_pending_adjustments?: Array<string>;
7253
+ /**
7254
+ * Group Unexplained
7255
+ *
7256
+ * The group close: residuals and intercompany disagreements left unexplained. Correct the books or post the explaining entry, or close over them knowingly with allow_unexplained_residuals.
7257
+ */
7258
+ group_unexplained?: Array<string>;
7259
+ /**
7260
+ * Group Not Footing
7261
+ *
7262
+ * The group close: the consolidated balance sheet's and equity statement's validation failures for the month.
7263
+ */
7264
+ group_not_footing?: Array<string>;
7229
7265
  /**
7230
7266
  * Last Close At
7231
7267
  */
@@ -10206,14 +10242,12 @@ export type LinkBankAccountResponse = {
10206
10242
  *
10207
10243
  * Link an entity to a taxonomy (creates the ENTITY_HAS_TAXONOMY edge).
10208
10244
  *
10209
- * This is how a graph declares "this entity reports under this taxonomy."
10210
- * For `chart_of_accounts` taxonomies, this tells the platform which CoA
10211
- * the entity uses. For reporting taxonomies, which standard (us-gaap,
10212
- * ifrs). Idempotent — re-linking returns the existing edge unchanged.
10213
- *
10214
- * CoA blocks auto-link at create time; use this to switch the primary
10215
- * CoA, link a reporting extension, or attach a custom ontology
10216
- * explicitly.
10245
+ * A `chart_of_accounts` link tells the platform which chart the entity
10246
+ * keeps its books in; CoA blocks auto-link at create time, so use this to
10247
+ * switch the primary one. The other bases record the association and
10248
+ * nothing reads them: statements render from the entity's reporting style,
10249
+ * whatever taxonomy is linked. Idempotent — re-linking returns the
10250
+ * existing edge unchanged.
10217
10251
  */
10218
10252
  export type LinkEntityTaxonomyRequest = {
10219
10253
  /**
@@ -10231,7 +10265,7 @@ export type LinkEntityTaxonomyRequest = {
10231
10265
  /**
10232
10266
  * Basis
10233
10267
  *
10234
- * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard like us-gaap), `mapping` (CoA→reporting rollup), `schedule` (schedule structure).
10268
+ * Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (a reporting standard), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). Only `chart_of_accounts` is read; the others are recorded and do not change how statements render.
10235
10269
  */
10236
10270
  basis?: 'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule';
10237
10271
  /**
@@ -15778,7 +15812,7 @@ export type PreviewConsolidationEntriesResponse = {
15778
15812
  /**
15779
15813
  * Up To Date
15780
15814
  *
15781
- * True when nothing is proposed, withheld or left out: the consolidation entity already holds what the month needs. A closed month is up to date as posted; read `closed` first.
15815
+ * True when nothing is withheld or left out and the consolidation entity holds what the month needs, posted or in the month's drafts (then `proposals` lists what the drafts hold). A closed month is up to date as posted; read `closed` first.
15782
15816
  */
15783
15817
  up_to_date: boolean;
15784
15818
  /**
@@ -15787,6 +15821,12 @@ export type PreviewConsolidationEntriesResponse = {
15787
15821
  * True when the consolidation entity has closed the month: its entries are as posted, and nothing is recomputed.
15788
15822
  */
15789
15823
  closed?: boolean;
15824
+ /**
15825
+ * Incomplete
15826
+ *
15827
+ * True when the engine left an entry out — a member's books it cannot read, an account the consolidation entity lacks; `notes` says which. The group close waits on it whatever the residuals.
15828
+ */
15829
+ incomplete?: boolean;
15790
15830
  /**
15791
15831
  * Drafted Entry Ids
15792
15832
  *