@robosystems/client 2.26.0 → 2.27.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.
@@ -711,13 +711,13 @@ export type AssociationResponse = {
711
711
  /**
712
712
  * Replaced Association Id
713
713
  *
714
- * The arc this write removed in the same transaction, when the call named one in `replaces_association_id`.
714
+ * The arc this one replaced, when the write named one in `replaces_association_id`. On a read, set for an arc whose move reached a closed month.
715
715
  */
716
716
  replaced_association_id?: string | null;
717
717
  /**
718
718
  * Reclassified Periods
719
719
  *
720
- * Closed months whose live statements now read through this arc while their stamped sets keep the answer as closed. Empty unless the write replaced an arc on an account with landed history in a closed month.
720
+ * Closed months whose live statements read through this arc while their stamped sets keep the answer as closed. Empty unless the arc replaced one on an account with landed history in a closed month.
721
721
  */
722
722
  reclassified_periods?: Array<string>;
723
723
  };
@@ -909,51 +909,6 @@ export type AvailableGraphTiersResponse = {
909
909
  */
910
910
  tiers: Array<GraphTierInfo>;
911
911
  };
912
- /**
913
- * BackfillPeriodOutcome
914
- *
915
- * Per-month result of a plan-history backfill pass.
916
- */
917
- export type BackfillPeriodOutcome = {
918
- /**
919
- * Period
920
- *
921
- * The month, in YYYY-MM
922
- */
923
- period: string;
924
- /**
925
- * Status
926
- *
927
- * stamped: reopen → reclose completed. skipped_drafts: the month holds draft entries the backfill refuses to post — review via list-period-drafts, then close-period or re-run. failed: the reclose raised; processing halted (see detail).
928
- */
929
- status: string;
930
- /**
931
- * Statements Stamped
932
- *
933
- * Whether the reclose stamped canonical statement FactSets. False with a statement_stamp_note soft-skip when reporting isn't set up.
934
- */
935
- statements_stamped?: boolean;
936
- /**
937
- * Statement Stamp Note
938
- *
939
- * Soft-skip reason when statements_stamped is false
940
- */
941
- statement_stamp_note?: string | null;
942
- /**
943
- * Statement Rule Summary
944
- *
945
- * Statement-rule verification tally for the month's stamped sets (pass/fail/error/skipped); None when no rules ran.
946
- */
947
- statement_rule_summary?: {
948
- [key: string]: number;
949
- } | null;
950
- /**
951
- * Detail
952
- *
953
- * Human-readable detail for skipped/failed months
954
- */
955
- detail?: string | null;
956
- };
957
912
  /**
958
913
  * BackfillPlanHistoryOperation
959
914
  *
@@ -1027,50 +982,6 @@ export type BackfillPlanHistoryOperation = {
1027
982
  */
1028
983
  note?: string | null;
1029
984
  };
1030
- /**
1031
- * BackfillPlanHistoryResponse
1032
- *
1033
- * Response from one chunked plan-history backfill call.
1034
- */
1035
- export type BackfillPlanHistoryResponse = {
1036
- fiscal_calendar: FiscalCalendarResponse;
1037
- /**
1038
- * Earliest Available Period
1039
- *
1040
- * First month with ledger data — the hard floor for backfill
1041
- */
1042
- earliest_available_period: string;
1043
- /**
1044
- * Effective Start Period
1045
- *
1046
- * The start actually used after clamping to earliest_available_period
1047
- */
1048
- effective_start_period: string;
1049
- /**
1050
- * Closed Through
1051
- *
1052
- * The close boundary the backfill runs up to (inclusive)
1053
- */
1054
- closed_through: string;
1055
- /**
1056
- * Period Rows Created
1057
- *
1058
- * FiscalPeriod rows seeded (baseline-closed) for months the calendar didn't cover yet
1059
- */
1060
- period_rows_created?: number;
1061
- /**
1062
- * Processed
1063
- *
1064
- * Months this call attempted, oldest first
1065
- */
1066
- processed?: Array<BackfillPeriodOutcome>;
1067
- /**
1068
- * Remaining Periods
1069
- *
1070
- * Months still lacking canonical statement sets that this call did not attempt (beyond max_periods, or after a failure halt). Loop until empty.
1071
- */
1072
- remaining_periods?: Array<string>;
1073
- };
1074
985
  /**
1075
986
  * BackupCreateRequest
1076
987
  *
@@ -2013,6 +1924,12 @@ export type ClosePeriodOperation = {
2013
1924
  * 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.
2014
1925
  */
2015
1926
  allow_unreconciled_accounts?: boolean;
1927
+ /**
1928
+ * Allow Held Bank Lines
1929
+ *
1930
+ * Override the held-bank-line gate — close even though bank lines a sync held out of an earlier, closed month (dated there, arriving after it closed) are still undecided. Each is recorded as decided by this close and stops blocking; none posts. Prefer reopening the month they are dated in, which gives them back to classify and commit. The override is recorded in the close audit note.
1931
+ */
1932
+ allow_held_bank_lines?: boolean;
2016
1933
  /**
2017
1934
  * Allow Unexplained Residuals
2018
1935
  *
@@ -2096,7 +2013,7 @@ export type ClosePeriodResponse = {
2096
2013
  /**
2097
2014
  * Gate Findings
2098
2015
  *
2099
- * Blocker codes a shadow close recorded instead of enforcing: sync_stale, pending_obligations, stranded_obligations, reconciling_items, unposted_source_events, unreconciled_accounts. Empty outside shadow.
2016
+ * Blocker codes a shadow close recorded instead of enforcing: sync_stale, pending_obligations, stranded_obligations, reconciling_items, unposted_source_events, unreconciled_accounts, held_bank_lines. Empty outside shadow.
2100
2017
  */
2101
2018
  gate_findings?: Array<string>;
2102
2019
  /**
@@ -3011,7 +2928,7 @@ export type CreateAgentRequest = {
3011
2928
  /**
3012
2929
  * Tax Id
3013
2930
  *
3014
- * Tax ID (EIN / SSN / VAT). Used for 1099 / withholding reporting.
2931
+ * Tax ID (EIN / SSN / VAT), kept for 1099 and withholding reporting; no report reads it yet.
3015
2932
  */
3016
2933
  tax_id?: string | null;
3017
2934
  /**
@@ -3069,7 +2986,7 @@ export type CreateAgentRequest = {
3069
2986
  /**
3070
2987
  * Is 1099 Recipient
3071
2988
  *
3072
- * Marks a vendor as 1099-eligible. Drives year-end 1099 reporting.
2989
+ * Marks a vendor as 1099-eligible: a flag a year-end 1099 summary will read. No report reads it yet.
3073
2990
  */
3074
2991
  is_1099_recipient?: boolean;
3075
2992
  /**
@@ -3565,7 +3482,7 @@ export type CreateEventHandlerRequest = {
3565
3482
  /**
3566
3483
  * Origin
3567
3484
  *
3568
- * Provenance of the handler. `tenant` = author by graph owner; `hub` = platform-shipped template (immutable for tenants).
3485
+ * Provenance of the handler. `tenant` = authored on this graph, the only value a caller may set; `hub` = platform-shipped template.
3569
3486
  */
3570
3487
  origin?: 'hub' | 'tenant';
3571
3488
  /**
@@ -4174,6 +4091,12 @@ export type CreateTaxonomyBlockRequest = {
4174
4091
  * Required when `taxonomy_type == 'reporting_extension'` — the id of the library `reporting_standard` being extended.
4175
4092
  */
4176
4093
  parent_taxonomy_id?: string | null;
4094
+ /**
4095
+ * Entity Id
4096
+ *
4097
+ * For a `chart_of_accounts`: the entity whose books it keeps, default the group parent. It becomes that entity's primary chart only if the entity has none; otherwise it is linked beside the primary, which stays. Not read by other types.
4098
+ */
4099
+ entity_id?: string | null;
4177
4100
  /**
4178
4101
  * Version
4179
4102
  */
@@ -6206,6 +6129,12 @@ export type EvaluateRulesRequest = {
6206
6129
  * Upper bound on the fact period window (inclusive).
6207
6130
  */
6208
6131
  period_end?: string | null;
6132
+ /**
6133
+ * Entity Id
6134
+ *
6135
+ * The entity whose facts bind, when no `fact_set_id` pins them; default the group parent. On a group, each entity's statements share the structure.
6136
+ */
6137
+ entity_id?: string | null;
6209
6138
  };
6210
6139
  /**
6211
6140
  * EvaluateRulesResponse
@@ -6746,6 +6675,18 @@ export type FactRecord = {
6746
6675
  * Entity name; present only when an entity filter was applied
6747
6676
  */
6748
6677
  entity_name?: string | null;
6678
+ /**
6679
+ * Presentation
6680
+ *
6681
+ * 'as_closed' when the value is the one the period's close stamped, kept as the month closed; null otherwise. A live read of the books (live-financial-statement) can differ from it once a mapping is reclassified after the close.
6682
+ */
6683
+ presentation?: string | null;
6684
+ /**
6685
+ * Stamped At
6686
+ *
6687
+ * When the close stamped the value (ISO 8601); set with 'as_closed'.
6688
+ */
6689
+ stamped_at?: string | null;
6749
6690
  };
6750
6691
  /**
6751
6692
  * FactSetLite
@@ -7126,7 +7067,7 @@ export type FiscalCalendarResponse = {
7126
7067
  /**
7127
7068
  * Blockers
7128
7069
  *
7129
- * 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'
7070
+ * 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', 'held_bank_lines'; on the consolidation entity, whose close is the group's, also 'entity_open', 'adjustments_unposted', 'residual_unexplained', 'consolidated_does_not_foot'
7130
7071
  */
7131
7072
  blockers?: Array<string>;
7132
7073
  /**
@@ -7189,6 +7130,18 @@ export type FiscalCalendarResponse = {
7189
7130
  * Source identifiers (or event ids) of up to 5 unposted source events, so the blocker names what is holding the close.
7190
7131
  */
7191
7132
  unposted_source_event_sample?: Array<string>;
7133
+ /**
7134
+ * Held Bank Line Count
7135
+ *
7136
+ * Bank lines a sync held out of an earlier, closed month — dated there, arriving after it closed — that no close has decided on. They block the next close: reopen the month they are dated in, which gives them back to post, or close over them knowingly with allow_held_bank_lines. Listed by list-event-blocks with status='voided' and void_reason 'feed_in_closed_month'.
7137
+ */
7138
+ held_bank_line_count?: number;
7139
+ /**
7140
+ * Held Bank Line Sample
7141
+ *
7142
+ * Up to 5 held lines, oldest first, as 'date: description amount [event id]', so the blocker names what is holding the close.
7143
+ */
7144
+ held_bank_line_sample?: Array<string>;
7192
7145
  /**
7193
7146
  * Unreconciled Account Count
7194
7147
  *
@@ -10392,6 +10345,12 @@ export type LiveFinancialStatementResponse = {
10392
10345
  * The entities summed, parent first; on `consolidated` the consolidation entity comes last.
10393
10346
  */
10394
10347
  combined_entity_ids?: Array<string>;
10348
+ /**
10349
+ * Presentation
10350
+ *
10351
+ * Always 'live': the books as they stand, through the current mapping. A closed month's figures as its close stamped them (`as_closed` on build-fact-grid and on statement columns) can differ once a mapping was reclassified after the close.
10352
+ */
10353
+ presentation?: string;
10395
10354
  /**
10396
10355
  * Statement Type
10397
10356
  */
@@ -11515,51 +11474,6 @@ export type OperationEnvelopeAssociationResponse = {
11515
11474
  */
11516
11475
  idempotentReplay?: boolean;
11517
11476
  };
11518
- /**
11519
- * OperationEnvelope[BackfillPlanHistoryResponse]
11520
- */
11521
- export type OperationEnvelopeBackfillPlanHistoryResponse = {
11522
- /**
11523
- * Operation
11524
- *
11525
- * Kebab-case operation name
11526
- */
11527
- operation: string;
11528
- /**
11529
- * Operationid
11530
- *
11531
- * op_-prefixed ULID for audit and SSE correlation
11532
- */
11533
- operationId: string;
11534
- /**
11535
- * Status
11536
- *
11537
- * Operation lifecycle state
11538
- */
11539
- status: 'completed' | 'pending' | 'failed';
11540
- /**
11541
- * Command-specific result payload
11542
- */
11543
- result?: BackfillPlanHistoryResponse | null;
11544
- /**
11545
- * At
11546
- *
11547
- * ISO-8601 UTC timestamp
11548
- */
11549
- at: string;
11550
- /**
11551
- * Createdby
11552
- *
11553
- * User ID that initiated the operation
11554
- */
11555
- createdBy?: string | null;
11556
- /**
11557
- * Idempotentreplay
11558
- *
11559
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11560
- */
11561
- idempotentReplay?: boolean;
11562
- };
11563
11477
  /**
11564
11478
  * OperationEnvelope[BindTextBlockResponse]
11565
11479
  */
@@ -16208,7 +16122,7 @@ export type ReconciliationComponent = {
16208
16122
  /**
16209
16123
  * Kind
16210
16124
  *
16211
- * `schedule`, `statement`, or `outstanding`: a ledger line on a bank-fed account that did not come from the feed, dated on or before the statement, so the bank had not cleared it.
16125
+ * `schedule`, `statement`, `outstanding`: a ledger line on a bank-fed account that did not come from the feed, dated on or before the statement, so the bank had not cleared it; or `stale_outstanding`: such a line dated before the statement's cycle, which the bank should have cleared by now. A stale line is listed but not counted toward the balance, so the difference it would explain stays unexplained until it clears, is voided or is re-dated.
16212
16126
  */
16213
16127
  kind?: string | null;
16214
16128
  /**
@@ -17068,7 +16982,7 @@ export type RecordStatementBalanceRequest = {
17068
16982
  /**
17069
16983
  * Document Id
17070
16984
  *
17071
- * The statement itself, as a document already added with create-document. Kept on the record as evidence.
16985
+ * The statement itself, as a document already added with create-document. Kept on the record as evidence. Recording the same account and date again keeps the earlier record's document when this is omitted; an empty string drops it.
17072
16986
  */
17073
16987
  document_id?: string | null;
17074
16988
  /**
@@ -17315,6 +17229,18 @@ export type RenderingPeriodLite = {
17315
17229
  * True when this column comes from a forecast scenario's FactSet — the machine-readable seam marker (labels also carry a '(forecast)' suffix, but consumers should key styling off this flag, not label parsing). None/absent = an actuals column.
17316
17230
  */
17317
17231
  forecast?: boolean | null;
17232
+ /**
17233
+ * Presentation
17234
+ *
17235
+ * 'as_closed' when the column's figures are the ones its month's close stamped, kept as the month closed; a live read of the books (live-financial-statement) can differ from them once a mapping is reclassified after the close. None for a report's own snapshot or a forecast column.
17236
+ */
17237
+ presentation?: string | null;
17238
+ /**
17239
+ * Stamped At
17240
+ *
17241
+ * When the close stamped the column; set with 'as_closed'.
17242
+ */
17243
+ stamped_at?: string | null;
17318
17244
  };
17319
17245
  /**
17320
17246
  * RenderingRowLite
@@ -32548,9 +32474,9 @@ export type BackfillPlanHistoryResponses = {
32548
32474
  /**
32549
32475
  * Successful Response
32550
32476
  */
32551
- 200: OperationEnvelopeBackfillPlanHistoryResponse;
32477
+ 202: OperationEnvelope;
32552
32478
  };
32553
- export type BackfillPlanHistoryResponse2 = BackfillPlanHistoryResponses[keyof BackfillPlanHistoryResponses];
32479
+ export type BackfillPlanHistoryResponse = BackfillPlanHistoryResponses[keyof BackfillPlanHistoryResponses];
32554
32480
  export type PromoteObligationsData = {
32555
32481
  body: PromoteObligationsRequest;
32556
32482
  headers?: {