@nominalso/vibe-host 0.5.1 → 0.7.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/dist/index.d.ts CHANGED
@@ -11,6 +11,14 @@ type AccountingBalanceOutput = {
11
11
  balance?: number;
12
12
  currency?: AccountingCurrency | null;
13
13
  };
14
+ type AccountingBulkSetLineDimensionValueRequest = {
15
+ dimension_id: string;
16
+ dimension_value_id: string;
17
+ line_ids: Array<string>;
18
+ };
19
+ type AccountingBulkSetLineDimensionValueResponse = {
20
+ updated_count: number;
21
+ };
14
22
  type AccountingCerPaginationOutput = {
15
23
  results?: Array<AccountingConsolidationExchangeRate>;
16
24
  pagination?: AccountingPaginationOutput | null;
@@ -79,6 +87,35 @@ type AccountingDimensionValue = {
79
87
  effective_rule_id?: number | null;
80
88
  has_children?: boolean;
81
89
  };
90
+ /**
91
+ * SDK-facing shape of a single dimension value's movement balance over the requested window.
92
+ *
93
+ * Mirrors the internal DimensionBalance — primary/secondary currency amounts, their credit/debit
94
+ * splits, and CTA — so the Rollforward has the full breakdown, but as a stable Response type
95
+ * decoupled from the aggregation model. Field names match the source so it maps via
96
+ * model_validate(from_attributes).
97
+ */
98
+ type AccountingDimensionValueBalanceResponse = {
99
+ dimension_id: string;
100
+ dimension_value_id?: string | null;
101
+ subsidiary_id: number;
102
+ primary_currency_amount?: number | null;
103
+ credit_primary_currency_amount?: number | null;
104
+ debit_primary_currency_amount?: number | null;
105
+ secondary_currency_amount?: number | null;
106
+ credit_secondary_currency_amount?: number | null;
107
+ debit_secondary_currency_amount?: number | null;
108
+ cta_amount?: number | null;
109
+ cta_credit_amount?: number | null;
110
+ cta_debit_amount?: number | null;
111
+ };
112
+ type AccountingDimensionValueCreateUpdate = {
113
+ value: string;
114
+ subsidiary_id?: number | null;
115
+ provider_uid?: string | null;
116
+ parent_id?: string | null;
117
+ children?: Array<AccountingDimensionValueCreateUpdate>;
118
+ };
82
119
  type AccountingDimensionValueOverrideSource = 'user' | 'provider';
83
120
  type AccountingDimensionValueSlim = {
84
121
  id: string;
@@ -326,6 +363,10 @@ type AccountingPaginationPositionInput = {
326
363
  };
327
364
  type AccountingPeriod = 'Annual' | 'Quarterly' | 'Monthly';
328
365
  type AccountingProviderOperationErrorType = 'Connection Error' | 'Authentication Error' | 'Data Operation Error' | 'Server Error' | 'Not Ready For Sync';
366
+ type AccountingSetLineDimensionValueRequest = {
367
+ dimension_id: string;
368
+ dimension_value_id: string;
369
+ };
329
370
  type AccountingSimpleCoAPaginationOutput = {
330
371
  results: Array<AccountingSimpleTAccount>;
331
372
  pagination?: AccountingPaginationOutput | null;
@@ -718,12 +759,7 @@ type ActivityBillCreate = {
718
759
  journal_entry_id?: string | null;
719
760
  is_nominal?: boolean;
720
761
  };
721
- type ActivityBillDataInput = {
722
- bill: ActivityBillCreate;
723
- bill_items: Array<ActivityBillItemCreate>;
724
- dimension_value_ids?: Array<string>;
725
- };
726
- type ActivityBillDataOutput = {
762
+ type ActivityBillData = {
727
763
  bill: ActivityBillCreate;
728
764
  bill_items: Array<ActivityBillItemCreate>;
729
765
  dimension_value_ids?: Array<string>;
@@ -771,16 +807,15 @@ type ActivityBodyGetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPost = {
771
807
  slim?: boolean;
772
808
  entity_ids?: Array<string>;
773
809
  entity_type?: ActivityTaskEntityType | null;
810
+ /**
811
+ * Include the associated entity objects (provider or subsidiary details) in the response.
812
+ */
774
813
  with_entities?: boolean;
775
814
  };
776
815
  type ActivityConsolidationExchangeRateType = 'current' | 'average' | 'historical';
777
- type ActivityCreateBillTaskActionDataInput = {
778
- action_type?: 'create_bill';
779
- bill_data: ActivityBillDataInput;
780
- };
781
- type ActivityCreateBillTaskActionDataOutput = {
816
+ type ActivityCreateBillTaskActionData = {
782
817
  action_type?: 'create_bill';
783
- bill_data: ActivityBillDataOutput;
818
+ bill_data: ActivityBillData;
784
819
  };
785
820
  type ActivityCreateIctEliminationActionTemplateInput = {
786
821
  action_type?: 'create_ict_elimination_entries';
@@ -866,11 +901,7 @@ type ActivityCreateJournalEntryTaskScheduleActionDataOutput = {
866
901
  due_date: ActivityDueDate;
867
902
  schedule_name: string;
868
903
  };
869
- type ActivityCreateLockPeriodTaskActionDataInput = {
870
- action_type?: 'lock_consolidation_period';
871
- period_data: ActivityPeriodData;
872
- };
873
- type ActivityCreateLockPeriodTaskActionDataOutput = {
904
+ type ActivityCreateLockPeriodTaskActionData = {
874
905
  action_type?: 'lock_consolidation_period';
875
906
  period_data: ActivityPeriodData;
876
907
  };
@@ -1200,19 +1231,7 @@ type ActivityLeaseAmortizationScheduleActionTemplateOutput = {
1200
1231
  };
1201
1232
  type ActivityLeaseEscalatorFrequency = 'monthly' | 'quarterly' | 'annually';
1202
1233
  type ActivityLeasePaymentFrequency = 'monthly' | 'quarterly' | 'annually' | 'once';
1203
- type ActivityLeasePaymentScheduleActionTemplateInput = {
1204
- action_type?: 'lease_payment';
1205
- lease_id: string;
1206
- lease_name: string;
1207
- currency: ActivityCurrency;
1208
- lease_dimension_value_id: string;
1209
- vendor_id: string;
1210
- billing_account_id: string;
1211
- payment_terms: Array<ActivityLeasePaymentTerm>;
1212
- migration_date?: string | null;
1213
- is_draft?: boolean;
1214
- };
1215
- type ActivityLeasePaymentScheduleActionTemplateOutput = {
1234
+ type ActivityLeasePaymentScheduleActionTemplate = {
1216
1235
  action_type?: 'lease_payment';
1217
1236
  lease_id: string;
1218
1237
  lease_name: string;
@@ -1237,15 +1256,7 @@ type ActivityLeasePaymentTerm = {
1237
1256
  subsidiary_id?: number | null;
1238
1257
  lease_id: string;
1239
1258
  };
1240
- type ActivityLeaseTermReminderActionTemplateInput = {
1241
- action_type?: 'lease_term_reminder';
1242
- lease_id: string;
1243
- lease_name: string;
1244
- payment_terms: Array<ActivityLeasePaymentTerm>;
1245
- migration_date?: string | null;
1246
- is_draft?: boolean;
1247
- };
1248
- type ActivityLeaseTermReminderActionTemplateOutput = {
1259
+ type ActivityLeaseTermReminderActionTemplate = {
1249
1260
  action_type?: 'lease_term_reminder';
1250
1261
  lease_id: string;
1251
1262
  lease_name: string;
@@ -1350,25 +1361,15 @@ type ActivityPeriodInstanceProgressBreakdownApi = {
1350
1361
  progress: ActivityTasksProgress;
1351
1362
  activities?: Array<ActivityActivitySubsidiaryProgress>;
1352
1363
  };
1353
- type ActivityPostBillDataInput = {
1354
- bill_id: string;
1355
- bill: ActivityBillUpdateBase;
1356
- bill_items?: Array<ActivityBillItemCreate> | null;
1357
- dimension_value_ids?: Array<string>;
1358
- };
1359
- type ActivityPostBillDataOutput = {
1364
+ type ActivityPostBillData = {
1360
1365
  bill_id: string;
1361
1366
  bill: ActivityBillUpdateBase;
1362
1367
  bill_items?: Array<ActivityBillItemCreate> | null;
1363
1368
  dimension_value_ids?: Array<string>;
1364
1369
  };
1365
- type ActivityPostBillTaskActionDataInput = {
1366
- action_type?: 'post_bill';
1367
- bill_data: ActivityPostBillDataInput;
1368
- };
1369
- type ActivityPostBillTaskActionDataOutput = {
1370
+ type ActivityPostBillTaskActionData = {
1370
1371
  action_type?: 'post_bill';
1371
- bill_data: ActivityPostBillDataOutput;
1372
+ bill_data: ActivityPostBillData;
1372
1373
  };
1373
1374
  type ActivityPostIctActionTemplate = {
1374
1375
  action_type?: 'post_ict';
@@ -1459,7 +1460,13 @@ type ActivitySlimTaskDefinitionWithInstances = {
1459
1460
  due_date: ActivityTaskDueDate;
1460
1461
  preparer_due_date?: ActivityDueDate | null;
1461
1462
  description?: string | null;
1463
+ /**
1464
+ * User ID of the person responsible for preparing this task.
1465
+ */
1462
1466
  preparer_id?: string | null;
1467
+ /**
1468
+ * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
1469
+ */
1463
1470
  assignee_id?: string | null;
1464
1471
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1465
1472
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1489,13 +1496,13 @@ type ActivitySlimTaskDefinitionWithInstances = {
1489
1496
  action_type?: 'test_schedule_action';
1490
1497
  } & ActivityTestScheduleActionTemplate) | ({
1491
1498
  action_type?: 'lease_payment';
1492
- } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1499
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
1493
1500
  action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1494
1501
  } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1495
1502
  action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1496
1503
  } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1497
1504
  action_type?: 'lease_term_reminder';
1498
- } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1505
+ } & ActivityLeaseTermReminderActionTemplate) | ({
1499
1506
  action_type?: 'create_journal_entry_schedule';
1500
1507
  } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1501
1508
  action_type?: 'create_journal_entries';
@@ -1691,9 +1698,9 @@ type ActivityTaskActionInput = {
1691
1698
  action_type?: 'test_action';
1692
1699
  } & ActivityTestActionData) | ({
1693
1700
  action_type?: 'create_bill';
1694
- } & ActivityCreateBillTaskActionDataInput) | ({
1701
+ } & ActivityCreateBillTaskActionData) | ({
1695
1702
  action_type?: 'post_bill';
1696
- } & ActivityPostBillTaskActionDataInput) | ({
1703
+ } & ActivityPostBillTaskActionData) | ({
1697
1704
  action_type?: 'post_journal_entry';
1698
1705
  } & ActivityPostJournalEntryTaskActionDataInput) | ({
1699
1706
  action_type?: 'post_ict';
@@ -1703,7 +1710,7 @@ type ActivityTaskActionInput = {
1703
1710
  action_type?: 'failure_task';
1704
1711
  } & ActivityFailureTaskActionData) | ({
1705
1712
  action_type?: 'lock_consolidation_period';
1706
- } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1713
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1707
1714
  action_type?: 'create_journal_entries_bulk';
1708
1715
  } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1709
1716
  action_type?: 'match_resolution';
@@ -1718,9 +1725,9 @@ type ActivityTaskActionInput = {
1718
1725
  action_type?: 'test_action';
1719
1726
  } & ActivityTestActionData) | ({
1720
1727
  action_type?: 'create_bill';
1721
- } & ActivityCreateBillTaskActionDataInput) | ({
1728
+ } & ActivityCreateBillTaskActionData) | ({
1722
1729
  action_type?: 'post_bill';
1723
- } & ActivityPostBillTaskActionDataInput) | ({
1730
+ } & ActivityPostBillTaskActionData) | ({
1724
1731
  action_type?: 'post_journal_entry';
1725
1732
  } & ActivityPostJournalEntryTaskActionDataInput) | ({
1726
1733
  action_type?: 'post_ict';
@@ -1730,7 +1737,7 @@ type ActivityTaskActionInput = {
1730
1737
  action_type?: 'failure_task';
1731
1738
  } & ActivityFailureTaskActionData) | ({
1732
1739
  action_type?: 'lock_consolidation_period';
1733
- } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1740
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1734
1741
  action_type?: 'create_journal_entries_bulk';
1735
1742
  } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1736
1743
  action_type?: 'match_resolution';
@@ -1754,9 +1761,9 @@ type ActivityTaskActionOutput = {
1754
1761
  action_type?: 'test_action';
1755
1762
  } & ActivityTestActionData) | ({
1756
1763
  action_type?: 'create_bill';
1757
- } & ActivityCreateBillTaskActionDataOutput) | ({
1764
+ } & ActivityCreateBillTaskActionData) | ({
1758
1765
  action_type?: 'post_bill';
1759
- } & ActivityPostBillTaskActionDataOutput) | ({
1766
+ } & ActivityPostBillTaskActionData) | ({
1760
1767
  action_type?: 'post_journal_entry';
1761
1768
  } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1762
1769
  action_type?: 'post_ict';
@@ -1766,7 +1773,7 @@ type ActivityTaskActionOutput = {
1766
1773
  action_type?: 'failure_task';
1767
1774
  } & ActivityFailureTaskActionData) | ({
1768
1775
  action_type?: 'lock_consolidation_period';
1769
- } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1776
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1770
1777
  action_type?: 'create_journal_entries_bulk';
1771
1778
  } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1772
1779
  action_type?: 'match_resolution';
@@ -1781,9 +1788,9 @@ type ActivityTaskActionOutput = {
1781
1788
  action_type?: 'test_action';
1782
1789
  } & ActivityTestActionData) | ({
1783
1790
  action_type?: 'create_bill';
1784
- } & ActivityCreateBillTaskActionDataOutput) | ({
1791
+ } & ActivityCreateBillTaskActionData) | ({
1785
1792
  action_type?: 'post_bill';
1786
- } & ActivityPostBillTaskActionDataOutput) | ({
1793
+ } & ActivityPostBillTaskActionData) | ({
1787
1794
  action_type?: 'post_journal_entry';
1788
1795
  } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1789
1796
  action_type?: 'post_ict';
@@ -1793,7 +1800,7 @@ type ActivityTaskActionOutput = {
1793
1800
  action_type?: 'failure_task';
1794
1801
  } & ActivityFailureTaskActionData) | ({
1795
1802
  action_type?: 'lock_consolidation_period';
1796
- } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1803
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1797
1804
  action_type?: 'create_journal_entries_bulk';
1798
1805
  } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1799
1806
  action_type?: 'match_resolution';
@@ -1830,7 +1837,13 @@ type ActivityTaskDefinition = {
1830
1837
  due_date: ActivityTaskDueDate;
1831
1838
  preparer_due_date?: ActivityDueDate | null;
1832
1839
  description?: string | null;
1840
+ /**
1841
+ * User ID of the person responsible for preparing this task.
1842
+ */
1833
1843
  preparer_id?: string | null;
1844
+ /**
1845
+ * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
1846
+ */
1834
1847
  assignee_id?: string | null;
1835
1848
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1836
1849
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1860,13 +1873,13 @@ type ActivityTaskDefinition = {
1860
1873
  action_type?: 'test_schedule_action';
1861
1874
  } & ActivityTestScheduleActionTemplate) | ({
1862
1875
  action_type?: 'lease_payment';
1863
- } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1876
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
1864
1877
  action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1865
1878
  } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1866
1879
  action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1867
1880
  } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1868
1881
  action_type?: 'lease_term_reminder';
1869
- } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1882
+ } & ActivityLeaseTermReminderActionTemplate) | ({
1870
1883
  action_type?: 'create_journal_entry_schedule';
1871
1884
  } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1872
1885
  action_type?: 'create_journal_entries';
@@ -1896,7 +1909,13 @@ type ActivityTaskDefinitionUpdate = {
1896
1909
  due_date: ActivityTaskDueDate;
1897
1910
  preparer_due_date?: ActivityDueDate | null;
1898
1911
  description?: string | null;
1912
+ /**
1913
+ * User ID of the person responsible for preparing this task.
1914
+ */
1899
1915
  preparer_id?: string | null;
1916
+ /**
1917
+ * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
1918
+ */
1900
1919
  assignee_id?: string | null;
1901
1920
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1902
1921
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1916,7 +1935,13 @@ type ActivityTaskDefinitionWithActionCreateApi = {
1916
1935
  due_date: ActivityTaskDueDate;
1917
1936
  preparer_due_date?: ActivityDueDate | null;
1918
1937
  description?: string | null;
1938
+ /**
1939
+ * User ID of the person responsible for preparing this task.
1940
+ */
1919
1941
  preparer_id?: string | null;
1942
+ /**
1943
+ * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
1944
+ */
1920
1945
  assignee_id?: string | null;
1921
1946
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1922
1947
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1946,13 +1971,13 @@ type ActivityTaskDefinitionWithActionCreateApi = {
1946
1971
  action_type?: 'test_schedule_action';
1947
1972
  } & ActivityTestScheduleActionTemplate) | ({
1948
1973
  action_type?: 'lease_payment';
1949
- } & ActivityLeasePaymentScheduleActionTemplateInput) | ({
1974
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
1950
1975
  action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1951
1976
  } & ActivityLeaseAmortizationScheduleActionTemplateInput) | ({
1952
1977
  action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1953
1978
  } & ActivityLeaseAmortizationOpeningBalanceActionTemplateInput) | ({
1954
1979
  action_type?: 'lease_term_reminder';
1955
- } & ActivityLeaseTermReminderActionTemplateInput) | ({
1980
+ } & ActivityLeaseTermReminderActionTemplate) | ({
1956
1981
  action_type?: 'create_journal_entry_schedule';
1957
1982
  } & ActivityCreateJournalEntryScheduleActionTemplateInput) | ({
1958
1983
  action_type?: 'create_journal_entries';
@@ -1971,6 +1996,79 @@ type ActivityTaskDefinitionWithActionCreateApi = {
1971
1996
  reconciliation_type?: 'account_reconciliation';
1972
1997
  } & ActivityAccountReconciliationParams) | null;
1973
1998
  };
1999
+ type ActivityTaskDefinitionWithInstances = {
2000
+ name: string;
2001
+ due_date: ActivityTaskDueDate;
2002
+ preparer_due_date?: ActivityDueDate | null;
2003
+ description?: string | null;
2004
+ /**
2005
+ * User ID of the person responsible for preparing this task.
2006
+ */
2007
+ preparer_id?: string | null;
2008
+ /**
2009
+ * User ID of the person assigned to complete this task. Note: task definitions use preparer_id/assignee_id for assignment; reviewer_id is set at the activity definition level, not on task definitions.
2010
+ */
2011
+ assignee_id?: string | null;
2012
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
2013
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2014
+ end_date?: string | null;
2015
+ task_type?: ActivityTaskType | null;
2016
+ created_at?: string | null;
2017
+ last_modified_at?: string | null;
2018
+ is_deleted?: boolean;
2019
+ activity_definition_id: string;
2020
+ start_date: string;
2021
+ subsidiary_ids: Array<number>;
2022
+ activity_instance_id?: string | null;
2023
+ recurring: boolean;
2024
+ id?: string;
2025
+ creator_user_id?: string | null;
2026
+ is_manual_task?: boolean;
2027
+ entities?: Array<ActivityTaskEntityMapping>;
2028
+ action_template?: (({
2029
+ action_type?: 'create_journal_entry';
2030
+ } & ActivityCreateJournalEntryActionTemplateOutput) | ({
2031
+ action_type?: 'create_ict_elimination_entries';
2032
+ } & ActivityCreateIctEliminationActionTemplateOutput) | ({
2033
+ action_type?: 'post_ict';
2034
+ } & ActivityPostIctActionTemplate) | ({
2035
+ action_type?: 'test_action';
2036
+ } & ActivityTestActionTemplate) | ({
2037
+ action_type?: 'test_schedule_action';
2038
+ } & ActivityTestScheduleActionTemplate) | ({
2039
+ action_type?: 'lease_payment';
2040
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
2041
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
2042
+ } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
2043
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
2044
+ } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
2045
+ action_type?: 'lease_term_reminder';
2046
+ } & ActivityLeaseTermReminderActionTemplate) | ({
2047
+ action_type?: 'create_journal_entry_schedule';
2048
+ } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
2049
+ action_type?: 'create_journal_entries';
2050
+ } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
2051
+ action_type?: 'failure_task';
2052
+ } & ActivityFailureActionTemplate) | ({
2053
+ action_type?: 'lock_consolidation_period';
2054
+ } & ActivityLockConsolidationRateActionTemplate) | ({
2055
+ action_type?: 'create_journal_entries_bulk';
2056
+ } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
2057
+ action_type?: 'match_resolution';
2058
+ } & ActivityMatchResolutionActionTemplate) | ({
2059
+ action_type?: 'reconciliation_submit';
2060
+ } & ActivityReconciliationSubmitActionTemplate)) | null;
2061
+ reconciliation_definition_params?: ({
2062
+ reconciliation_type?: 'account_reconciliation';
2063
+ } & ActivityAccountReconciliationParams) | null;
2064
+ trigger_id?: string | null;
2065
+ workflow_execution_id?: string | null;
2066
+ creator_task_id?: string | null;
2067
+ activity_definition: ActivityActivityDefinitionCreateWithType;
2068
+ action_type?: string | null;
2069
+ task_instances?: Array<ActivityTaskInstanceWithAction>;
2070
+ creator: ActivityTaskCreator | null;
2071
+ };
1974
2072
  /**
1975
2073
  * Task-specific DueDate that carries an optional preparer/reviewer offset.
1976
2074
  *
@@ -2016,6 +2114,9 @@ type ActivityTaskInstanceUpdate = {
2016
2114
  due_date?: string | null;
2017
2115
  assignee_id?: string | null;
2018
2116
  preparer_id?: string | null;
2117
+ /**
2118
+ * Not supported for task instances — task instances use preparer_id/assignee_id only. reviewer_id is set at the activity definition level, not on tasks.
2119
+ */
2019
2120
  reviewer_id?: string | null;
2020
2121
  status?: ActivityTaskStatus | null;
2021
2122
  preparer_due_date?: string | null;
@@ -2036,6 +2137,9 @@ type ActivityTaskInstanceUpdateClearAction = {
2036
2137
  due_date?: string | null;
2037
2138
  assignee_id?: string | null;
2038
2139
  preparer_id?: string | null;
2140
+ /**
2141
+ * Not supported for task instances — task instances use preparer_id/assignee_id only. reviewer_id is set at the activity definition level, not on tasks.
2142
+ */
2039
2143
  reviewer_id?: string | null;
2040
2144
  status?: ActivityTaskStatus | null;
2041
2145
  preparer_due_date?: string | null;
@@ -2050,6 +2154,9 @@ type ActivityTaskInstanceUpdateWithAction = {
2050
2154
  due_date?: string | null;
2051
2155
  assignee_id?: string | null;
2052
2156
  preparer_id?: string | null;
2157
+ /**
2158
+ * Not supported for task instances — task instances use preparer_id/assignee_id only. reviewer_id is set at the activity definition level, not on tasks.
2159
+ */
2053
2160
  reviewer_id?: string | null;
2054
2161
  status?: ActivityTaskStatus | null;
2055
2162
  preparer_due_date?: string | null;
@@ -2542,6 +2649,18 @@ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLin
2542
2649
  is_nominal_ledger?: boolean | null;
2543
2650
  memo?: string | null;
2544
2651
  journal_entry_line_ids?: Array<string> | null;
2652
+ /**
2653
+ * Filter to lines posted to any of these GL accounts.
2654
+ */
2655
+ account_ids?: Array<string> | null;
2656
+ /**
2657
+ * Filter to lines assigned any of these dimension values.
2658
+ */
2659
+ dimension_value_ids?: Array<string> | null;
2660
+ /**
2661
+ * Return only lines with no dimension assignment. Takes precedence over dimension_value_ids.
2662
+ */
2663
+ unassigned_only?: boolean | null;
2545
2664
  page?: number | null;
2546
2665
  per_page?: number | null;
2547
2666
  include_total?: boolean;
@@ -2557,19 +2676,65 @@ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLin
2557
2676
  200: Array<AccountingJournalEntryLineWithJournalEntryWithDimensionsWithOperationCtx> | AccountingJournalEntryLinePaginationOutput;
2558
2677
  };
2559
2678
  type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponse = GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses[keyof GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses];
2679
+ type SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutData = {
2680
+ body: AccountingSetLineDimensionValueRequest;
2681
+ path: {
2682
+ subsidiary_id: number;
2683
+ /**
2684
+ * The journal-entry line to assign the dimension value to.
2685
+ */
2686
+ line_id: string;
2687
+ };
2688
+ query?: never;
2689
+ url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry/lines/{line_id}/dimension-value';
2690
+ };
2691
+ type SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutResponses = {
2692
+ /**
2693
+ * Successful Response
2694
+ */
2695
+ 200: AccountingLineDimensionValueOverride;
2696
+ };
2697
+ type SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutResponse = SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutResponses[keyof SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutResponses];
2698
+ type BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutData = {
2699
+ body: AccountingBulkSetLineDimensionValueRequest;
2700
+ path: {
2701
+ subsidiary_id: number;
2702
+ };
2703
+ query?: never;
2704
+ url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry/lines/dimension-value/bulk';
2705
+ };
2706
+ type BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutResponses = {
2707
+ /**
2708
+ * Successful Response
2709
+ */
2710
+ 200: AccountingBulkSetLineDimensionValueResponse;
2711
+ };
2712
+ type BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutResponse = BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutResponses[keyof BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutResponses];
2560
2713
  type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData = {
2561
2714
  body?: AccountingPaginationPositionInput | null;
2562
2715
  path: {
2563
2716
  subsidiary_id: number;
2564
2717
  };
2565
2718
  query?: {
2719
+ /**
2720
+ * Filter by journal entry type. Values: adjustment (manual Nominal entry), elimination (consolidation entry), book_entry, ic_transaction (inter-company).
2721
+ */
2566
2722
  entry_types?: Array<AccountingJournalEntryType> | null;
2723
+ /**
2724
+ * Filter by one or more human-readable reference numbers (e.g. ref #42).
2725
+ */
2567
2726
  ref_numbers?: Array<string> | null;
2568
2727
  child_subsidiaries?: Array<number> | null;
2569
2728
  from_date?: string | null;
2570
2729
  to_date?: string | null;
2730
+ /**
2731
+ * If true, return only manually created Nominal ledger entries, excluding provider-synced transactions.
2732
+ */
2571
2733
  is_nominal_ledger?: boolean | null;
2572
2734
  memo?: string | null;
2735
+ /**
2736
+ * Filter by status. Values: Draft (not yet posted), Submitted (pending review), Posted (finalised and reflected in reports).
2737
+ */
2573
2738
  entry_statuses?: Array<AccountingJournalEntryStatus> | null;
2574
2739
  /**
2575
2740
  * Filter entries where any line has this amount
@@ -2610,8 +2775,17 @@ type GetDimensionsApiAccountingDimensionGetData = {
2610
2775
  body?: never;
2611
2776
  path?: never;
2612
2777
  query?: {
2778
+ /**
2779
+ * Filter dimensions scoped to a specific subsidiary (integer ID).
2780
+ */
2613
2781
  subsidiary_id?: number | null;
2782
+ /**
2783
+ * Maximum number of dimension values to return per dimension (default 1000).
2784
+ */
2614
2785
  values_limit?: number | null;
2786
+ /**
2787
+ * If true, include the full set of dimension values and their auto-assignment rules in the response.
2788
+ */
2615
2789
  with_rules_and_values?: boolean;
2616
2790
  };
2617
2791
  url: '/api/accounting/dimension';
@@ -2623,6 +2797,57 @@ type GetDimensionsApiAccountingDimensionGetResponses = {
2623
2797
  200: Array<AccountingDimensionWithRules>;
2624
2798
  };
2625
2799
  type GetDimensionsApiAccountingDimensionGetResponse = GetDimensionsApiAccountingDimensionGetResponses[keyof GetDimensionsApiAccountingDimensionGetResponses];
2800
+ type GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetData = {
2801
+ body?: never;
2802
+ path: {
2803
+ dimension_id: string;
2804
+ };
2805
+ query: {
2806
+ /**
2807
+ * Subsidiary whose balances to read.
2808
+ */
2809
+ subsidiary_id: number;
2810
+ /**
2811
+ * Accounts to include in the balance.
2812
+ */
2813
+ account_ids: Array<string>;
2814
+ /**
2815
+ * Start of the movement window (inclusive).
2816
+ */
2817
+ from_date: string;
2818
+ /**
2819
+ * End of the movement window (inclusive).
2820
+ */
2821
+ to_date: string;
2822
+ /**
2823
+ * Restrict to these dimension values; omit or leave empty to return all of the dimension's values.
2824
+ */
2825
+ dimension_value_ids?: Array<string> | null;
2826
+ };
2827
+ url: '/api/accounting/dimension/{dimension_id}/balance';
2828
+ };
2829
+ type GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetResponses = {
2830
+ /**
2831
+ * Successful Response
2832
+ */
2833
+ 200: Array<AccountingDimensionValueBalanceResponse>;
2834
+ };
2835
+ type GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetResponse = GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetResponses[keyof GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetResponses];
2836
+ type AddDimensionValueApiAccountingDimensionDimensionIdValuePostData = {
2837
+ body: AccountingDimensionValueCreateUpdate;
2838
+ path: {
2839
+ dimension_id: string;
2840
+ };
2841
+ query?: never;
2842
+ url: '/api/accounting/dimension/{dimension_id}/value';
2843
+ };
2844
+ type AddDimensionValueApiAccountingDimensionDimensionIdValuePostResponses = {
2845
+ /**
2846
+ * Successful Response
2847
+ */
2848
+ 200: AccountingDimensionValue;
2849
+ };
2850
+ type AddDimensionValueApiAccountingDimensionDimensionIdValuePostResponse = AddDimensionValueApiAccountingDimensionDimensionIdValuePostResponses[keyof AddDimensionValueApiAccountingDimensionDimensionIdValuePostResponses];
2626
2851
  type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetData = {
2627
2852
  body?: never;
2628
2853
  path: {
@@ -2643,10 +2868,25 @@ type GetDimensionValuesApiAccountingDimensionValueGetData = {
2643
2868
  body?: never;
2644
2869
  path?: never;
2645
2870
  query?: {
2871
+ /**
2872
+ * Filter to values belonging to specific dimension IDs.
2873
+ */
2646
2874
  dimension_ids?: Array<string> | null;
2875
+ /**
2876
+ * Filter to specific dimension value IDs.
2877
+ */
2647
2878
  dimension_value_ids?: Array<string> | null;
2879
+ /**
2880
+ * Text search filter on the parent dimension name.
2881
+ */
2648
2882
  dimension_name?: string | null;
2883
+ /**
2884
+ * Text search filter on the dimension value name.
2885
+ */
2649
2886
  dimension_value?: string | null;
2887
+ /**
2888
+ * Return a lightweight response without rules and extended metadata.
2889
+ */
2650
2890
  slim?: boolean;
2651
2891
  /**
2652
2892
  * Sort dimension values alphabetically by value
@@ -2728,7 +2968,13 @@ type GetActivityDefinitionsApiActivityActivityDefinitionGetData = {
2728
2968
  body?: never;
2729
2969
  path?: never;
2730
2970
  query?: {
2971
+ /**
2972
+ * Include disabled activity definitions in the response.
2973
+ */
2731
2974
  with_disabled_activity?: boolean;
2975
+ /**
2976
+ * Include the nested task definition templates in the response.
2977
+ */
2732
2978
  with_task_definitions?: boolean;
2733
2979
  };
2734
2980
  url: '/api/activity/activity-definition';
@@ -2748,6 +2994,9 @@ type GetPeriodInstancesApiActivityPeriodInstanceGetData = {
2748
2994
  path?: never;
2749
2995
  query?: {
2750
2996
  period?: ActivityPeriod | null;
2997
+ /**
2998
+ * Return lightweight response without task instance details.
2999
+ */
2751
3000
  slim?: boolean;
2752
3001
  from_date?: string | null;
2753
3002
  to_date?: string | null;
@@ -2761,8 +3010,17 @@ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
2761
3010
  period_instance_id: string;
2762
3011
  };
2763
3012
  query?: {
3013
+ /**
3014
+ * Include activities that are currently disabled in the response.
3015
+ */
2764
3016
  with_disabled_activity?: boolean;
3017
+ /**
3018
+ * Include child subsidiary period instances in the response.
3019
+ */
2765
3020
  include_children?: boolean;
3021
+ /**
3022
+ * Filter to specific subsidiary integer IDs.
3023
+ */
2766
3024
  subsidiary_ids?: Array<number> | null;
2767
3025
  };
2768
3026
  url: '/api/activity/period-instance/{period_instance_id}';
@@ -2770,6 +3028,9 @@ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
2770
3028
  type GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData = {
2771
3029
  body?: never;
2772
3030
  path: {
3031
+ /**
3032
+ * Human-readable period identifier, e.g. '2024-01' for January 2024 or '2024-Q1' for Q1 2024.
3033
+ */
2773
3034
  period_display_id: string;
2774
3035
  };
2775
3036
  query?: {
@@ -2839,7 +3100,7 @@ type CreateTaskDefinitionApiActivityTaskDefinitionPostResponses = {
2839
3100
  /**
2840
3101
  * Successful Response
2841
3102
  */
2842
- 200: ActivityTaskDefinition;
3103
+ 200: ActivityTaskDefinitionWithInstances;
2843
3104
  };
2844
3105
  type CreateTaskDefinitionApiActivityTaskDefinitionPostResponse = CreateTaskDefinitionApiActivityTaskDefinitionPostResponses[keyof CreateTaskDefinitionApiActivityTaskDefinitionPostResponses];
2845
3106
  type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
@@ -2847,6 +3108,9 @@ type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
2847
3108
  path?: never;
2848
3109
  query?: {
2849
3110
  entity_ids?: Array<string>;
3111
+ /**
3112
+ * Filter by the type of entity the task applies to. Values: SUBSIDIARY (subsidiary-level tasks), PROVIDER (accounting provider tasks), ACTIVITY (activity-level tasks).
3113
+ */
2850
3114
  entity_type?: ActivityTaskEntityType | null;
2851
3115
  with_instances?: boolean;
2852
3116
  q?: string | null;
@@ -2895,8 +3159,17 @@ type GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData = {
2895
3159
  activity_instance_id: string;
2896
3160
  };
2897
3161
  query?: {
3162
+ /**
3163
+ * Return lightweight task instance summaries instead of full task details.
3164
+ */
2898
3165
  with_slim_task_instances?: boolean;
3166
+ /**
3167
+ * Include the nested task instance list in the response.
3168
+ */
2899
3169
  with_instances?: boolean;
3170
+ /**
3171
+ * Include reconciliation-specific fields in the response.
3172
+ */
2900
3173
  for_reconciliation?: boolean;
2901
3174
  subsidiary_ids?: Array<number> | null;
2902
3175
  };
@@ -2914,9 +3187,9 @@ type GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTask
2914
3187
  status?: Array<ActivityTaskStatus> | null;
2915
3188
  preparer_ids?: Array<string> | null;
2916
3189
  reviewer_ids?: Array<string> | null;
2917
- due_date_period?: ActivityPeriodFilter;
2918
- due_date_from?: string;
2919
- due_date_to?: string;
3190
+ due_date_period?: ActivityPeriodFilter | null;
3191
+ due_date_from?: string | null;
3192
+ due_date_to?: string | null;
2920
3193
  slim?: boolean;
2921
3194
  without_activity_instance?: boolean;
2922
3195
  page?: number | null;
@@ -2936,6 +3209,9 @@ type GetActivityInstancesApiActivityActivityInstanceGetData = {
2936
3209
  activity_definition_id?: string | null;
2937
3210
  from_date?: string | null;
2938
3211
  to_date?: string | null;
3212
+ /**
3213
+ * Return enriched response including subsidiary details and provider information alongside each activity instance.
3214
+ */
2939
3215
  as_enriched?: boolean;
2940
3216
  };
2941
3217
  url: '/api/activity/activity-instance';
@@ -2997,16 +3273,28 @@ type GetAllTaskInstancesApiActivityTaskInstanceGetData = {
2997
3273
  body?: never;
2998
3274
  path?: never;
2999
3275
  query?: {
3276
+ /**
3277
+ * Filter by task status. Values: PENDING (not started), IN_REVIEW (submitted for review), DONE (completed and approved), CANCELLED.
3278
+ */
3000
3279
  status?: Array<ActivityTaskStatus>;
3001
3280
  subsidiary_ids?: Array<number>;
3002
3281
  activity_definition_ids?: Array<string>;
3003
3282
  preparer_ids?: Array<string> | null;
3004
3283
  reviewer_ids?: Array<string> | null;
3005
3284
  period_instance_id?: string | null;
3285
+ /**
3286
+ * Filter to tasks for a specific period (e.g. '2024-01').
3287
+ */
3006
3288
  period_display_id?: string | null;
3007
3289
  period_instance_ids?: Array<string> | null;
3008
3290
  period_display_ids?: Array<string> | null;
3291
+ /**
3292
+ * Exclude task instances of specific types. Values: RECONCILIATION, APPROVAL, MANUAL.
3293
+ */
3009
3294
  exclude_task_types?: Array<ActivityTaskType> | null;
3295
+ /**
3296
+ * Return lightweight response without full task details.
3297
+ */
3010
3298
  slim?: boolean;
3011
3299
  sort?: ActivitySortableFieldsTask;
3012
3300
  order?: ActivitySortingOrder | null;
@@ -3110,6 +3398,9 @@ type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse =
3110
3398
  type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData = {
3111
3399
  body?: never;
3112
3400
  path: {
3401
+ /**
3402
+ * The tenant UUID or its string name identifier (slug).
3403
+ */
3113
3404
  tenant_id_or_name: string;
3114
3405
  };
3115
3406
  query?: never;
@@ -3143,9 +3434,15 @@ type GetAllSubsidiariesApiTenancySubsidiaryGetResponse = GetAllSubsidiariesApiTe
3143
3434
  type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData = {
3144
3435
  body?: never;
3145
3436
  path: {
3437
+ /**
3438
+ * Integer subsidiary ID from the tenancy hierarchy.
3439
+ */
3146
3440
  subsidiary_id: number;
3147
3441
  };
3148
3442
  query?: {
3443
+ /**
3444
+ * If true, include consolidation-only elimination subsidiaries in the response.
3445
+ */
3149
3446
  with_elimination_subsidiaries?: boolean;
3150
3447
  };
3151
3448
  url: '/api/tenancy/subsidiary/{subsidiary_id}';
@@ -3445,6 +3742,22 @@ interface RequestRegistry {
3445
3742
  payload: Omit<GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetData, 'url'>;
3446
3743
  data: GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponse;
3447
3744
  };
3745
+ GET_DIMENSION_BALANCE: {
3746
+ payload: Omit<GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetData, 'url'>;
3747
+ data: GetDimensionBalanceApiAccountingDimensionDimensionIdBalanceGetResponse;
3748
+ };
3749
+ ADD_DIMENSION_VALUE: {
3750
+ payload: Omit<AddDimensionValueApiAccountingDimensionDimensionIdValuePostData, 'url'>;
3751
+ data: AddDimensionValueApiAccountingDimensionDimensionIdValuePostResponse;
3752
+ };
3753
+ SET_LINE_DIMENSION_VALUE: {
3754
+ payload: Omit<SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutData, 'url'>;
3755
+ data: SetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesLineIdDimensionValuePutResponse;
3756
+ };
3757
+ BULK_SET_LINE_DIMENSION_VALUE: {
3758
+ payload: Omit<BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutData, 'url'>;
3759
+ data: BulkSetLineDimensionValueApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesDimensionValueBulkPutResponse;
3760
+ };
3448
3761
  GET_JOURNAL_LINES: {
3449
3762
  payload: Omit<GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetData, 'url'>;
3450
3763
  data: GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponse;