@nominalso/vibe-bridge 0.6.0 → 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.
@@ -718,12 +718,7 @@ type ActivityBillCreate = {
718
718
  journal_entry_id?: string | null;
719
719
  is_nominal?: boolean;
720
720
  };
721
- type ActivityBillDataInput = {
722
- bill: ActivityBillCreate;
723
- bill_items: Array<ActivityBillItemCreate>;
724
- dimension_value_ids?: Array<string>;
725
- };
726
- type ActivityBillDataOutput = {
721
+ type ActivityBillData = {
727
722
  bill: ActivityBillCreate;
728
723
  bill_items: Array<ActivityBillItemCreate>;
729
724
  dimension_value_ids?: Array<string>;
@@ -771,16 +766,15 @@ type ActivityBodyGetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPost = {
771
766
  slim?: boolean;
772
767
  entity_ids?: Array<string>;
773
768
  entity_type?: ActivityTaskEntityType | null;
769
+ /**
770
+ * Include the associated entity objects (provider or subsidiary details) in the response.
771
+ */
774
772
  with_entities?: boolean;
775
773
  };
776
774
  type ActivityConsolidationExchangeRateType = 'current' | 'average' | 'historical';
777
- type ActivityCreateBillTaskActionDataInput = {
775
+ type ActivityCreateBillTaskActionData = {
778
776
  action_type?: 'create_bill';
779
- bill_data: ActivityBillDataInput;
780
- };
781
- type ActivityCreateBillTaskActionDataOutput = {
782
- action_type?: 'create_bill';
783
- bill_data: ActivityBillDataOutput;
777
+ bill_data: ActivityBillData;
784
778
  };
785
779
  type ActivityCreateIctEliminationActionTemplateInput = {
786
780
  action_type?: 'create_ict_elimination_entries';
@@ -866,11 +860,7 @@ type ActivityCreateJournalEntryTaskScheduleActionDataOutput = {
866
860
  due_date: ActivityDueDate;
867
861
  schedule_name: string;
868
862
  };
869
- type ActivityCreateLockPeriodTaskActionDataInput = {
870
- action_type?: 'lock_consolidation_period';
871
- period_data: ActivityPeriodData;
872
- };
873
- type ActivityCreateLockPeriodTaskActionDataOutput = {
863
+ type ActivityCreateLockPeriodTaskActionData = {
874
864
  action_type?: 'lock_consolidation_period';
875
865
  period_data: ActivityPeriodData;
876
866
  };
@@ -1200,19 +1190,7 @@ type ActivityLeaseAmortizationScheduleActionTemplateOutput = {
1200
1190
  };
1201
1191
  type ActivityLeaseEscalatorFrequency = 'monthly' | 'quarterly' | 'annually';
1202
1192
  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 = {
1193
+ type ActivityLeasePaymentScheduleActionTemplate = {
1216
1194
  action_type?: 'lease_payment';
1217
1195
  lease_id: string;
1218
1196
  lease_name: string;
@@ -1237,15 +1215,7 @@ type ActivityLeasePaymentTerm = {
1237
1215
  subsidiary_id?: number | null;
1238
1216
  lease_id: string;
1239
1217
  };
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 = {
1218
+ type ActivityLeaseTermReminderActionTemplate = {
1249
1219
  action_type?: 'lease_term_reminder';
1250
1220
  lease_id: string;
1251
1221
  lease_name: string;
@@ -1350,25 +1320,15 @@ type ActivityPeriodInstanceProgressBreakdownApi = {
1350
1320
  progress: ActivityTasksProgress;
1351
1321
  activities?: Array<ActivityActivitySubsidiaryProgress>;
1352
1322
  };
1353
- type ActivityPostBillDataInput = {
1323
+ type ActivityPostBillData = {
1354
1324
  bill_id: string;
1355
1325
  bill: ActivityBillUpdateBase;
1356
1326
  bill_items?: Array<ActivityBillItemCreate> | null;
1357
1327
  dimension_value_ids?: Array<string>;
1358
1328
  };
1359
- type ActivityPostBillDataOutput = {
1360
- bill_id: string;
1361
- bill: ActivityBillUpdateBase;
1362
- bill_items?: Array<ActivityBillItemCreate> | null;
1363
- dimension_value_ids?: Array<string>;
1364
- };
1365
- type ActivityPostBillTaskActionDataInput = {
1366
- action_type?: 'post_bill';
1367
- bill_data: ActivityPostBillDataInput;
1368
- };
1369
- type ActivityPostBillTaskActionDataOutput = {
1329
+ type ActivityPostBillTaskActionData = {
1370
1330
  action_type?: 'post_bill';
1371
- bill_data: ActivityPostBillDataOutput;
1331
+ bill_data: ActivityPostBillData;
1372
1332
  };
1373
1333
  type ActivityPostIctActionTemplate = {
1374
1334
  action_type?: 'post_ict';
@@ -1459,7 +1419,13 @@ type ActivitySlimTaskDefinitionWithInstances = {
1459
1419
  due_date: ActivityTaskDueDate;
1460
1420
  preparer_due_date?: ActivityDueDate | null;
1461
1421
  description?: string | null;
1422
+ /**
1423
+ * User ID of the person responsible for preparing this task.
1424
+ */
1462
1425
  preparer_id?: string | null;
1426
+ /**
1427
+ * 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.
1428
+ */
1463
1429
  assignee_id?: string | null;
1464
1430
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1465
1431
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1489,13 +1455,13 @@ type ActivitySlimTaskDefinitionWithInstances = {
1489
1455
  action_type?: 'test_schedule_action';
1490
1456
  } & ActivityTestScheduleActionTemplate) | ({
1491
1457
  action_type?: 'lease_payment';
1492
- } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1458
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
1493
1459
  action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1494
1460
  } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1495
1461
  action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1496
1462
  } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1497
1463
  action_type?: 'lease_term_reminder';
1498
- } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1464
+ } & ActivityLeaseTermReminderActionTemplate) | ({
1499
1465
  action_type?: 'create_journal_entry_schedule';
1500
1466
  } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1501
1467
  action_type?: 'create_journal_entries';
@@ -1691,9 +1657,9 @@ type ActivityTaskActionInput = {
1691
1657
  action_type?: 'test_action';
1692
1658
  } & ActivityTestActionData) | ({
1693
1659
  action_type?: 'create_bill';
1694
- } & ActivityCreateBillTaskActionDataInput) | ({
1660
+ } & ActivityCreateBillTaskActionData) | ({
1695
1661
  action_type?: 'post_bill';
1696
- } & ActivityPostBillTaskActionDataInput) | ({
1662
+ } & ActivityPostBillTaskActionData) | ({
1697
1663
  action_type?: 'post_journal_entry';
1698
1664
  } & ActivityPostJournalEntryTaskActionDataInput) | ({
1699
1665
  action_type?: 'post_ict';
@@ -1703,7 +1669,7 @@ type ActivityTaskActionInput = {
1703
1669
  action_type?: 'failure_task';
1704
1670
  } & ActivityFailureTaskActionData) | ({
1705
1671
  action_type?: 'lock_consolidation_period';
1706
- } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1672
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1707
1673
  action_type?: 'create_journal_entries_bulk';
1708
1674
  } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1709
1675
  action_type?: 'match_resolution';
@@ -1718,9 +1684,9 @@ type ActivityTaskActionInput = {
1718
1684
  action_type?: 'test_action';
1719
1685
  } & ActivityTestActionData) | ({
1720
1686
  action_type?: 'create_bill';
1721
- } & ActivityCreateBillTaskActionDataInput) | ({
1687
+ } & ActivityCreateBillTaskActionData) | ({
1722
1688
  action_type?: 'post_bill';
1723
- } & ActivityPostBillTaskActionDataInput) | ({
1689
+ } & ActivityPostBillTaskActionData) | ({
1724
1690
  action_type?: 'post_journal_entry';
1725
1691
  } & ActivityPostJournalEntryTaskActionDataInput) | ({
1726
1692
  action_type?: 'post_ict';
@@ -1730,7 +1696,7 @@ type ActivityTaskActionInput = {
1730
1696
  action_type?: 'failure_task';
1731
1697
  } & ActivityFailureTaskActionData) | ({
1732
1698
  action_type?: 'lock_consolidation_period';
1733
- } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1699
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1734
1700
  action_type?: 'create_journal_entries_bulk';
1735
1701
  } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1736
1702
  action_type?: 'match_resolution';
@@ -1754,9 +1720,9 @@ type ActivityTaskActionOutput = {
1754
1720
  action_type?: 'test_action';
1755
1721
  } & ActivityTestActionData) | ({
1756
1722
  action_type?: 'create_bill';
1757
- } & ActivityCreateBillTaskActionDataOutput) | ({
1723
+ } & ActivityCreateBillTaskActionData) | ({
1758
1724
  action_type?: 'post_bill';
1759
- } & ActivityPostBillTaskActionDataOutput) | ({
1725
+ } & ActivityPostBillTaskActionData) | ({
1760
1726
  action_type?: 'post_journal_entry';
1761
1727
  } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1762
1728
  action_type?: 'post_ict';
@@ -1766,7 +1732,7 @@ type ActivityTaskActionOutput = {
1766
1732
  action_type?: 'failure_task';
1767
1733
  } & ActivityFailureTaskActionData) | ({
1768
1734
  action_type?: 'lock_consolidation_period';
1769
- } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1735
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1770
1736
  action_type?: 'create_journal_entries_bulk';
1771
1737
  } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1772
1738
  action_type?: 'match_resolution';
@@ -1781,9 +1747,9 @@ type ActivityTaskActionOutput = {
1781
1747
  action_type?: 'test_action';
1782
1748
  } & ActivityTestActionData) | ({
1783
1749
  action_type?: 'create_bill';
1784
- } & ActivityCreateBillTaskActionDataOutput) | ({
1750
+ } & ActivityCreateBillTaskActionData) | ({
1785
1751
  action_type?: 'post_bill';
1786
- } & ActivityPostBillTaskActionDataOutput) | ({
1752
+ } & ActivityPostBillTaskActionData) | ({
1787
1753
  action_type?: 'post_journal_entry';
1788
1754
  } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1789
1755
  action_type?: 'post_ict';
@@ -1793,7 +1759,7 @@ type ActivityTaskActionOutput = {
1793
1759
  action_type?: 'failure_task';
1794
1760
  } & ActivityFailureTaskActionData) | ({
1795
1761
  action_type?: 'lock_consolidation_period';
1796
- } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1762
+ } & ActivityCreateLockPeriodTaskActionData) | ({
1797
1763
  action_type?: 'create_journal_entries_bulk';
1798
1764
  } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1799
1765
  action_type?: 'match_resolution';
@@ -1830,7 +1796,13 @@ type ActivityTaskDefinition = {
1830
1796
  due_date: ActivityTaskDueDate;
1831
1797
  preparer_due_date?: ActivityDueDate | null;
1832
1798
  description?: string | null;
1799
+ /**
1800
+ * User ID of the person responsible for preparing this task.
1801
+ */
1833
1802
  preparer_id?: string | null;
1803
+ /**
1804
+ * 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.
1805
+ */
1834
1806
  assignee_id?: string | null;
1835
1807
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1836
1808
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1860,13 +1832,13 @@ type ActivityTaskDefinition = {
1860
1832
  action_type?: 'test_schedule_action';
1861
1833
  } & ActivityTestScheduleActionTemplate) | ({
1862
1834
  action_type?: 'lease_payment';
1863
- } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1835
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
1864
1836
  action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1865
1837
  } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1866
1838
  action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1867
1839
  } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1868
1840
  action_type?: 'lease_term_reminder';
1869
- } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1841
+ } & ActivityLeaseTermReminderActionTemplate) | ({
1870
1842
  action_type?: 'create_journal_entry_schedule';
1871
1843
  } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1872
1844
  action_type?: 'create_journal_entries';
@@ -1896,7 +1868,13 @@ type ActivityTaskDefinitionUpdate = {
1896
1868
  due_date: ActivityTaskDueDate;
1897
1869
  preparer_due_date?: ActivityDueDate | null;
1898
1870
  description?: string | null;
1871
+ /**
1872
+ * User ID of the person responsible for preparing this task.
1873
+ */
1899
1874
  preparer_id?: string | null;
1875
+ /**
1876
+ * 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.
1877
+ */
1900
1878
  assignee_id?: string | null;
1901
1879
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1902
1880
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1916,7 +1894,13 @@ type ActivityTaskDefinitionWithActionCreateApi = {
1916
1894
  due_date: ActivityTaskDueDate;
1917
1895
  preparer_due_date?: ActivityDueDate | null;
1918
1896
  description?: string | null;
1897
+ /**
1898
+ * User ID of the person responsible for preparing this task.
1899
+ */
1919
1900
  preparer_id?: string | null;
1901
+ /**
1902
+ * 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.
1903
+ */
1920
1904
  assignee_id?: string | null;
1921
1905
  blocks_tasks?: Array<ActivityTaskBlocking> | null;
1922
1906
  blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
@@ -1946,13 +1930,13 @@ type ActivityTaskDefinitionWithActionCreateApi = {
1946
1930
  action_type?: 'test_schedule_action';
1947
1931
  } & ActivityTestScheduleActionTemplate) | ({
1948
1932
  action_type?: 'lease_payment';
1949
- } & ActivityLeasePaymentScheduleActionTemplateInput) | ({
1933
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
1950
1934
  action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1951
1935
  } & ActivityLeaseAmortizationScheduleActionTemplateInput) | ({
1952
1936
  action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1953
1937
  } & ActivityLeaseAmortizationOpeningBalanceActionTemplateInput) | ({
1954
1938
  action_type?: 'lease_term_reminder';
1955
- } & ActivityLeaseTermReminderActionTemplateInput) | ({
1939
+ } & ActivityLeaseTermReminderActionTemplate) | ({
1956
1940
  action_type?: 'create_journal_entry_schedule';
1957
1941
  } & ActivityCreateJournalEntryScheduleActionTemplateInput) | ({
1958
1942
  action_type?: 'create_journal_entries';
@@ -1971,6 +1955,79 @@ type ActivityTaskDefinitionWithActionCreateApi = {
1971
1955
  reconciliation_type?: 'account_reconciliation';
1972
1956
  } & ActivityAccountReconciliationParams) | null;
1973
1957
  };
1958
+ type ActivityTaskDefinitionWithInstances = {
1959
+ name: string;
1960
+ due_date: ActivityTaskDueDate;
1961
+ preparer_due_date?: ActivityDueDate | null;
1962
+ description?: string | null;
1963
+ /**
1964
+ * User ID of the person responsible for preparing this task.
1965
+ */
1966
+ preparer_id?: string | null;
1967
+ /**
1968
+ * 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.
1969
+ */
1970
+ assignee_id?: string | null;
1971
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1972
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1973
+ end_date?: string | null;
1974
+ task_type?: ActivityTaskType | null;
1975
+ created_at?: string | null;
1976
+ last_modified_at?: string | null;
1977
+ is_deleted?: boolean;
1978
+ activity_definition_id: string;
1979
+ start_date: string;
1980
+ subsidiary_ids: Array<number>;
1981
+ activity_instance_id?: string | null;
1982
+ recurring: boolean;
1983
+ id?: string;
1984
+ creator_user_id?: string | null;
1985
+ is_manual_task?: boolean;
1986
+ entities?: Array<ActivityTaskEntityMapping>;
1987
+ action_template?: (({
1988
+ action_type?: 'create_journal_entry';
1989
+ } & ActivityCreateJournalEntryActionTemplateOutput) | ({
1990
+ action_type?: 'create_ict_elimination_entries';
1991
+ } & ActivityCreateIctEliminationActionTemplateOutput) | ({
1992
+ action_type?: 'post_ict';
1993
+ } & ActivityPostIctActionTemplate) | ({
1994
+ action_type?: 'test_action';
1995
+ } & ActivityTestActionTemplate) | ({
1996
+ action_type?: 'test_schedule_action';
1997
+ } & ActivityTestScheduleActionTemplate) | ({
1998
+ action_type?: 'lease_payment';
1999
+ } & ActivityLeasePaymentScheduleActionTemplate) | ({
2000
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
2001
+ } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
2002
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
2003
+ } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
2004
+ action_type?: 'lease_term_reminder';
2005
+ } & ActivityLeaseTermReminderActionTemplate) | ({
2006
+ action_type?: 'create_journal_entry_schedule';
2007
+ } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
2008
+ action_type?: 'create_journal_entries';
2009
+ } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
2010
+ action_type?: 'failure_task';
2011
+ } & ActivityFailureActionTemplate) | ({
2012
+ action_type?: 'lock_consolidation_period';
2013
+ } & ActivityLockConsolidationRateActionTemplate) | ({
2014
+ action_type?: 'create_journal_entries_bulk';
2015
+ } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
2016
+ action_type?: 'match_resolution';
2017
+ } & ActivityMatchResolutionActionTemplate) | ({
2018
+ action_type?: 'reconciliation_submit';
2019
+ } & ActivityReconciliationSubmitActionTemplate)) | null;
2020
+ reconciliation_definition_params?: ({
2021
+ reconciliation_type?: 'account_reconciliation';
2022
+ } & ActivityAccountReconciliationParams) | null;
2023
+ trigger_id?: string | null;
2024
+ workflow_execution_id?: string | null;
2025
+ creator_task_id?: string | null;
2026
+ activity_definition: ActivityActivityDefinitionCreateWithType;
2027
+ action_type?: string | null;
2028
+ task_instances?: Array<ActivityTaskInstanceWithAction>;
2029
+ creator: ActivityTaskCreator | null;
2030
+ };
1974
2031
  /**
1975
2032
  * Task-specific DueDate that carries an optional preparer/reviewer offset.
1976
2033
  *
@@ -2016,6 +2073,9 @@ type ActivityTaskInstanceUpdate = {
2016
2073
  due_date?: string | null;
2017
2074
  assignee_id?: string | null;
2018
2075
  preparer_id?: string | null;
2076
+ /**
2077
+ * 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.
2078
+ */
2019
2079
  reviewer_id?: string | null;
2020
2080
  status?: ActivityTaskStatus | null;
2021
2081
  preparer_due_date?: string | null;
@@ -2036,6 +2096,9 @@ type ActivityTaskInstanceUpdateClearAction = {
2036
2096
  due_date?: string | null;
2037
2097
  assignee_id?: string | null;
2038
2098
  preparer_id?: string | null;
2099
+ /**
2100
+ * 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.
2101
+ */
2039
2102
  reviewer_id?: string | null;
2040
2103
  status?: ActivityTaskStatus | null;
2041
2104
  preparer_due_date?: string | null;
@@ -2050,6 +2113,9 @@ type ActivityTaskInstanceUpdateWithAction = {
2050
2113
  due_date?: string | null;
2051
2114
  assignee_id?: string | null;
2052
2115
  preparer_id?: string | null;
2116
+ /**
2117
+ * 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.
2118
+ */
2053
2119
  reviewer_id?: string | null;
2054
2120
  status?: ActivityTaskStatus | null;
2055
2121
  preparer_due_date?: string | null;
@@ -2542,6 +2608,18 @@ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLin
2542
2608
  is_nominal_ledger?: boolean | null;
2543
2609
  memo?: string | null;
2544
2610
  journal_entry_line_ids?: Array<string> | null;
2611
+ /**
2612
+ * Filter to lines posted to any of these GL accounts.
2613
+ */
2614
+ account_ids?: Array<string> | null;
2615
+ /**
2616
+ * Filter to lines assigned any of these dimension values.
2617
+ */
2618
+ dimension_value_ids?: Array<string> | null;
2619
+ /**
2620
+ * Return only lines with no dimension assignment. Takes precedence over dimension_value_ids.
2621
+ */
2622
+ unassigned_only?: boolean | null;
2545
2623
  page?: number | null;
2546
2624
  per_page?: number | null;
2547
2625
  include_total?: boolean;
@@ -2563,13 +2641,25 @@ type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData
2563
2641
  subsidiary_id: number;
2564
2642
  };
2565
2643
  query?: {
2644
+ /**
2645
+ * Filter by journal entry type. Values: adjustment (manual Nominal entry), elimination (consolidation entry), book_entry, ic_transaction (inter-company).
2646
+ */
2566
2647
  entry_types?: Array<AccountingJournalEntryType> | null;
2648
+ /**
2649
+ * Filter by one or more human-readable reference numbers (e.g. ref #42).
2650
+ */
2567
2651
  ref_numbers?: Array<string> | null;
2568
2652
  child_subsidiaries?: Array<number> | null;
2569
2653
  from_date?: string | null;
2570
2654
  to_date?: string | null;
2655
+ /**
2656
+ * If true, return only manually created Nominal ledger entries, excluding provider-synced transactions.
2657
+ */
2571
2658
  is_nominal_ledger?: boolean | null;
2572
2659
  memo?: string | null;
2660
+ /**
2661
+ * Filter by status. Values: Draft (not yet posted), Submitted (pending review), Posted (finalised and reflected in reports).
2662
+ */
2573
2663
  entry_statuses?: Array<AccountingJournalEntryStatus> | null;
2574
2664
  /**
2575
2665
  * Filter entries where any line has this amount
@@ -2610,8 +2700,17 @@ type GetDimensionsApiAccountingDimensionGetData = {
2610
2700
  body?: never;
2611
2701
  path?: never;
2612
2702
  query?: {
2703
+ /**
2704
+ * Filter dimensions scoped to a specific subsidiary (integer ID).
2705
+ */
2613
2706
  subsidiary_id?: number | null;
2707
+ /**
2708
+ * Maximum number of dimension values to return per dimension (default 1000).
2709
+ */
2614
2710
  values_limit?: number | null;
2711
+ /**
2712
+ * If true, include the full set of dimension values and their auto-assignment rules in the response.
2713
+ */
2615
2714
  with_rules_and_values?: boolean;
2616
2715
  };
2617
2716
  url: '/api/accounting/dimension';
@@ -2643,10 +2742,25 @@ type GetDimensionValuesApiAccountingDimensionValueGetData = {
2643
2742
  body?: never;
2644
2743
  path?: never;
2645
2744
  query?: {
2745
+ /**
2746
+ * Filter to values belonging to specific dimension IDs.
2747
+ */
2646
2748
  dimension_ids?: Array<string> | null;
2749
+ /**
2750
+ * Filter to specific dimension value IDs.
2751
+ */
2647
2752
  dimension_value_ids?: Array<string> | null;
2753
+ /**
2754
+ * Text search filter on the parent dimension name.
2755
+ */
2648
2756
  dimension_name?: string | null;
2757
+ /**
2758
+ * Text search filter on the dimension value name.
2759
+ */
2649
2760
  dimension_value?: string | null;
2761
+ /**
2762
+ * Return a lightweight response without rules and extended metadata.
2763
+ */
2650
2764
  slim?: boolean;
2651
2765
  /**
2652
2766
  * Sort dimension values alphabetically by value
@@ -2728,7 +2842,13 @@ type GetActivityDefinitionsApiActivityActivityDefinitionGetData = {
2728
2842
  body?: never;
2729
2843
  path?: never;
2730
2844
  query?: {
2845
+ /**
2846
+ * Include disabled activity definitions in the response.
2847
+ */
2731
2848
  with_disabled_activity?: boolean;
2849
+ /**
2850
+ * Include the nested task definition templates in the response.
2851
+ */
2732
2852
  with_task_definitions?: boolean;
2733
2853
  };
2734
2854
  url: '/api/activity/activity-definition';
@@ -2748,6 +2868,9 @@ type GetPeriodInstancesApiActivityPeriodInstanceGetData = {
2748
2868
  path?: never;
2749
2869
  query?: {
2750
2870
  period?: ActivityPeriod | null;
2871
+ /**
2872
+ * Return lightweight response without task instance details.
2873
+ */
2751
2874
  slim?: boolean;
2752
2875
  from_date?: string | null;
2753
2876
  to_date?: string | null;
@@ -2761,8 +2884,17 @@ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
2761
2884
  period_instance_id: string;
2762
2885
  };
2763
2886
  query?: {
2887
+ /**
2888
+ * Include activities that are currently disabled in the response.
2889
+ */
2764
2890
  with_disabled_activity?: boolean;
2891
+ /**
2892
+ * Include child subsidiary period instances in the response.
2893
+ */
2765
2894
  include_children?: boolean;
2895
+ /**
2896
+ * Filter to specific subsidiary integer IDs.
2897
+ */
2766
2898
  subsidiary_ids?: Array<number> | null;
2767
2899
  };
2768
2900
  url: '/api/activity/period-instance/{period_instance_id}';
@@ -2770,6 +2902,9 @@ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
2770
2902
  type GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData = {
2771
2903
  body?: never;
2772
2904
  path: {
2905
+ /**
2906
+ * Human-readable period identifier, e.g. '2024-01' for January 2024 or '2024-Q1' for Q1 2024.
2907
+ */
2773
2908
  period_display_id: string;
2774
2909
  };
2775
2910
  query?: {
@@ -2839,7 +2974,7 @@ type CreateTaskDefinitionApiActivityTaskDefinitionPostResponses = {
2839
2974
  /**
2840
2975
  * Successful Response
2841
2976
  */
2842
- 200: ActivityTaskDefinition;
2977
+ 200: ActivityTaskDefinitionWithInstances;
2843
2978
  };
2844
2979
  type CreateTaskDefinitionApiActivityTaskDefinitionPostResponse = CreateTaskDefinitionApiActivityTaskDefinitionPostResponses[keyof CreateTaskDefinitionApiActivityTaskDefinitionPostResponses];
2845
2980
  type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
@@ -2847,6 +2982,9 @@ type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
2847
2982
  path?: never;
2848
2983
  query?: {
2849
2984
  entity_ids?: Array<string>;
2985
+ /**
2986
+ * Filter by the type of entity the task applies to. Values: SUBSIDIARY (subsidiary-level tasks), PROVIDER (accounting provider tasks), ACTIVITY (activity-level tasks).
2987
+ */
2850
2988
  entity_type?: ActivityTaskEntityType | null;
2851
2989
  with_instances?: boolean;
2852
2990
  q?: string | null;
@@ -2895,8 +3033,17 @@ type GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData = {
2895
3033
  activity_instance_id: string;
2896
3034
  };
2897
3035
  query?: {
3036
+ /**
3037
+ * Return lightweight task instance summaries instead of full task details.
3038
+ */
2898
3039
  with_slim_task_instances?: boolean;
3040
+ /**
3041
+ * Include the nested task instance list in the response.
3042
+ */
2899
3043
  with_instances?: boolean;
3044
+ /**
3045
+ * Include reconciliation-specific fields in the response.
3046
+ */
2900
3047
  for_reconciliation?: boolean;
2901
3048
  subsidiary_ids?: Array<number> | null;
2902
3049
  };
@@ -2914,9 +3061,9 @@ type GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTask
2914
3061
  status?: Array<ActivityTaskStatus> | null;
2915
3062
  preparer_ids?: Array<string> | null;
2916
3063
  reviewer_ids?: Array<string> | null;
2917
- due_date_period?: ActivityPeriodFilter;
2918
- due_date_from?: string;
2919
- due_date_to?: string;
3064
+ due_date_period?: ActivityPeriodFilter | null;
3065
+ due_date_from?: string | null;
3066
+ due_date_to?: string | null;
2920
3067
  slim?: boolean;
2921
3068
  without_activity_instance?: boolean;
2922
3069
  page?: number | null;
@@ -2936,6 +3083,9 @@ type GetActivityInstancesApiActivityActivityInstanceGetData = {
2936
3083
  activity_definition_id?: string | null;
2937
3084
  from_date?: string | null;
2938
3085
  to_date?: string | null;
3086
+ /**
3087
+ * Return enriched response including subsidiary details and provider information alongside each activity instance.
3088
+ */
2939
3089
  as_enriched?: boolean;
2940
3090
  };
2941
3091
  url: '/api/activity/activity-instance';
@@ -2997,16 +3147,28 @@ type GetAllTaskInstancesApiActivityTaskInstanceGetData = {
2997
3147
  body?: never;
2998
3148
  path?: never;
2999
3149
  query?: {
3150
+ /**
3151
+ * Filter by task status. Values: PENDING (not started), IN_REVIEW (submitted for review), DONE (completed and approved), CANCELLED.
3152
+ */
3000
3153
  status?: Array<ActivityTaskStatus>;
3001
3154
  subsidiary_ids?: Array<number>;
3002
3155
  activity_definition_ids?: Array<string>;
3003
3156
  preparer_ids?: Array<string> | null;
3004
3157
  reviewer_ids?: Array<string> | null;
3005
3158
  period_instance_id?: string | null;
3159
+ /**
3160
+ * Filter to tasks for a specific period (e.g. '2024-01').
3161
+ */
3006
3162
  period_display_id?: string | null;
3007
3163
  period_instance_ids?: Array<string> | null;
3008
3164
  period_display_ids?: Array<string> | null;
3165
+ /**
3166
+ * Exclude task instances of specific types. Values: RECONCILIATION, APPROVAL, MANUAL.
3167
+ */
3009
3168
  exclude_task_types?: Array<ActivityTaskType> | null;
3169
+ /**
3170
+ * Return lightweight response without full task details.
3171
+ */
3010
3172
  slim?: boolean;
3011
3173
  sort?: ActivitySortableFieldsTask;
3012
3174
  order?: ActivitySortingOrder | null;
@@ -3110,6 +3272,9 @@ type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse =
3110
3272
  type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData = {
3111
3273
  body?: never;
3112
3274
  path: {
3275
+ /**
3276
+ * The tenant UUID or its string name identifier (slug).
3277
+ */
3113
3278
  tenant_id_or_name: string;
3114
3279
  };
3115
3280
  query?: never;
@@ -3143,9 +3308,15 @@ type GetAllSubsidiariesApiTenancySubsidiaryGetResponse = GetAllSubsidiariesApiTe
3143
3308
  type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData = {
3144
3309
  body?: never;
3145
3310
  path: {
3311
+ /**
3312
+ * Integer subsidiary ID from the tenancy hierarchy.
3313
+ */
3146
3314
  subsidiary_id: number;
3147
3315
  };
3148
3316
  query?: {
3317
+ /**
3318
+ * If true, include consolidation-only elimination subsidiaries in the response.
3319
+ */
3149
3320
  with_elimination_subsidiaries?: boolean;
3150
3321
  };
3151
3322
  url: '/api/tenancy/subsidiary/{subsidiary_id}';