@nominalso/vibe-bridge 0.0.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.
@@ -0,0 +1,3512 @@
1
+ var version = "0.0.1";
2
+
3
+ type AccountingAccountDimensionValues = {
4
+ account_id: string;
5
+ assignments?: {
6
+ [key: string]: Array<AccountingDimensionValue>;
7
+ };
8
+ };
9
+ type AccountingAccountReportCategory = 'Balance Sheet' | 'P&L';
10
+ type AccountingAccountType = 'Bank' | 'Current Asset' | 'Non-current Asset' | 'Fixed Asset' | 'Depreciation' | 'Inventory' | 'Prepayment' | 'Undeposited Funds' | 'Other Assets' | 'Accounts Receivable' | 'CTA' | 'Equity' | 'Retained Earnings' | 'Other Equity' | 'Expense' | 'Other Expense' | 'Cost of Goods Sold' | 'Wages Expense' | 'Interest Expense' | 'Taxes Expense' | 'Depreciation Expense' | 'Amortization Expense' | 'Overhead' | 'Accounts Payable' | 'Credit Card' | 'Non-current Liability' | 'Current Liability' | 'Deferred Revenue' | 'Other Liability' | 'Revenue' | 'Sales' | 'Other Income' | 'Other Revenue' | 'Statistical';
11
+ type AccountingAccountingClass = 'Asset' | 'Equity' | 'Liability' | 'Revenue' | 'Expense' | 'Statistical';
12
+ type AccountingBalanceOutput = {
13
+ balance?: number;
14
+ currency?: AccountingCurrency | null;
15
+ };
16
+ type AccountingCerPaginationOutput = {
17
+ results?: Array<AccountingConsolidationExchangeRate>;
18
+ pagination?: AccountingPaginationOutput | null;
19
+ };
20
+ type AccountingCoAGroupBy = 'nominal_account' | 'accounting_class' | 'account_type' | 'report_category';
21
+ type AccountingCoaPaginationOutput = {
22
+ results: Array<AccountingTAccountOutput>;
23
+ pagination?: AccountingPaginationOutput | null;
24
+ };
25
+ type AccountingConsolidationExchangeRate = {
26
+ id: string;
27
+ from_subsidiary: number;
28
+ to_subsidiary: number;
29
+ current_default_rate: number;
30
+ current_rate: number;
31
+ average_default_rate: number;
32
+ average_rate: number;
33
+ historical_default_rate: number;
34
+ historical_rate: number;
35
+ by_provider: boolean;
36
+ for_cash_flows: boolean;
37
+ month: string;
38
+ period?: AccountingConsolidationExchangeRatePeriod | null;
39
+ readonly period_id: string;
40
+ };
41
+ type AccountingConsolidationExchangeRatePeriod = {
42
+ id: string;
43
+ period_type: AccountingPeriod;
44
+ start_date: string;
45
+ is_locked?: boolean;
46
+ };
47
+ type AccountingConsolidationExchangeRateType = 'current' | 'average' | 'historical';
48
+ type AccountingCurrency = 'United States Dollar' | 'Euro' | 'British Pound Sterling' | 'Indian Rupee' | 'Australian Dollar' | 'Canadian Dollar' | 'New Israeli Shekel' | 'Japanese Yen' | 'Sri Lankan Rupee' | 'New Zealand Dollar' | 'Swedish Krona' | 'South African Rand' | 'Singapore Dollar' | 'Indonesian Rupiah' | 'Danish Krone' | 'Hong Kong Dollar' | 'United Arab Emirates Dirham' | 'Argentine Peso' | 'Brazilian Real' | 'Bulgarian Lev' | 'Chinese Yuan' | 'Colombian Peso' | 'Czech Koruna' | 'Malaysian Ringgit' | 'Mexican Peso' | 'Myanmar Kyat' | 'New Taiwan Dollar' | 'Norwegian Krone' | 'Omani Rial' | 'Philippine Peso' | 'Polish Zloty' | 'Romanian Leu' | 'Swiss Franc' | 'Turkish Lira' | 'Serbian Dinar' | 'Hungarian Forint' | 'South Korean Won' | 'Armenian Dram' | 'Azerbaijani Manat' | 'Bahraini Dinar' | 'Chilean Peso' | 'Fijian Dollar' | 'Georgian Lari' | 'Guatemalan Quetzal' | 'Croatian Kuna' | 'Icelandic Krona' | 'Jordanian Dinar' | 'Kyrgyzstani Som' | 'Kuwaiti Dinar' | 'Kazakhstani Tenge' | 'Moroccan Dirham' | 'Papua New Guinean Kina' | 'Qatari Rial' | 'Russian Ruble' | 'Saudi Riyal' | 'Thai Baht' | 'Somali Shilling' | 'Tunisian Dinar' | 'Ukrainian Hryvnia' | 'Uzbekistani Som' | 'Vietnamese Dong' | 'Central African CFA Franc' | 'Afghani' | 'Lek' | 'Kwanza' | 'Aruban Florin' | 'Convertible Mark' | 'Barbados Dollar' | 'Taka' | 'Burundi Franc' | 'Bermudian Dollar' | 'Brunei Dollar' | 'Boliviano' | 'Mvdol' | 'Bahamian Dollar' | 'Ngultrum' | 'Pula' | 'Belarusian Ruble' | 'Belize Dollar' | 'Congolese Franc' | 'WIR Euro' | 'WIR Franc' | 'Unidad de Fomento' | 'Unidad de Valor Real' | 'Costa Rican Colon' | 'Cuban Peso' | 'Cabo Verde Escudo' | 'Djibouti Franc' | 'Dominican Peso' | 'Algerian Dinar' | 'Egyptian Pound' | 'Nakfa' | 'Ethiopian Birr' | 'Falkland Islands Pound' | 'Ghana Cedi' | 'Gibraltar Pound' | 'Dalasi' | 'Guinean Franc' | 'Guyana Dollar' | 'Lempira' | 'Gourde' | 'Iraqi Dinar' | 'Iranian Rial' | 'Jamaican Dollar' | 'Kenyan Shilling' | 'Riel' | 'Comorian Franc' | 'North Korean Won' | 'Cayman Islands Dollar' | 'Lao Kip' | 'Lebanese Pound' | 'Liberian Dollar' | 'Loti' | 'Libyan Dinar' | 'Moldovan Leu' | 'Malagasy Ariary' | 'Denar' | 'Tugrik' | 'Pataca' | 'Ouguiya' | 'Mauritius Rupee' | 'Rufiyaa' | 'Malawi Kwacha' | 'Mexican Unidad de Inversion (UDI)' | 'Mozambique Metical' | 'Namibia Dollar' | 'Naira' | 'Cordoba Oro' | 'Nepalese Rupee' | 'Balboa' | 'Sol' | 'Pakistan Rupee' | 'Guarani' | 'Rwanda Franc' | 'Solomon Islands Dollar' | 'Seychelles Rupee' | 'Sudanese Pound' | 'Saint Helena Pound' | 'Leone' | 'Surinam Dollar' | 'South Sudanese Pound' | 'Dobra' | 'El Salvador Colon' | 'Syrian Pound' | 'Lilangeni' | 'Somoni' | 'Turkmenistan New Manat' | "Pa'anga" | 'Trinidad and Tobago Dollar' | 'Tanzanian Shilling' | 'Uganda Shilling' | 'US Dollar (Next day)' | 'Uruguay Peso en Unidades Indexadas (UI)' | 'Peso Uruguayo' | 'Unidad Previsional' | 'Bolivar Digital' | 'Bolivar Soberano' | 'Vatu' | 'Tala' | 'Arab Accounting Dinar' | 'Silver' | 'Gold' | 'Bond Markets Unit European Composite Unit (EURCO)' | 'Bond Markets Unit European Monetary Unit (E.M.U.-6)' | 'Bond Markets Unit European Unit of Account 9 (E.U.A.-9)' | 'Bond Markets Unit European Unit of Account 17 (E.U.A.-17)' | 'East Caribbean Dollar' | 'Caribbean Guilder' | 'SDR (Special Drawing Right)' | 'CFA Franc BCEAO' | 'Palladium' | 'CFP Franc' | 'Platinum' | 'Sucre' | 'Codes specifically reserved for testing purposes' | 'ADB Unit of Account' | 'The codes assigned for transactions where no currency is involved' | 'Yemeni Rial' | 'Zambian Kwacha' | 'Zimbabwe Gold';
49
+ type AccountingDimension = {
50
+ name: string;
51
+ description?: string | null;
52
+ id: string;
53
+ is_default?: boolean;
54
+ values?: Array<AccountingDimensionValue>;
55
+ };
56
+ type AccountingDimensionRuleCreateUpdate = {
57
+ dimension_id: string;
58
+ order: number;
59
+ dimension_value_id: string;
60
+ name: string;
61
+ subsidiary_id?: number | null;
62
+ by_account_code?: Array<string> | null;
63
+ by_account_name?: string | null;
64
+ by_account_ids?: Array<string> | null;
65
+ by_account_types?: Array<AccountingAccountType> | null;
66
+ by_journal_entry_memo?: string | null;
67
+ by_journal_entry_created_from?: string | null;
68
+ by_journal_entry_line_memo?: string | null;
69
+ by_journal_entry_line_property?: string | null;
70
+ by_dimension_value_ids?: Array<string> | null;
71
+ by_empty_dimension_id_values?: Array<string> | null;
72
+ };
73
+ type AccountingDimensionValue = {
74
+ id?: string | null;
75
+ value: string;
76
+ subsidiary_id?: number | null;
77
+ provider_uid?: string | null;
78
+ parent_id?: string | null;
79
+ dimension_id: string;
80
+ is_default: boolean;
81
+ effective_rule_id?: number | null;
82
+ has_children?: boolean;
83
+ };
84
+ type AccountingDimensionValueOverrideSource = 'user' | 'provider';
85
+ type AccountingDimensionValueSlim = {
86
+ id: string;
87
+ value: string;
88
+ dimension_id: string;
89
+ has_children?: boolean;
90
+ };
91
+ type AccountingDimensionValueWithChildren = {
92
+ id?: string | null;
93
+ value: string;
94
+ subsidiary_id?: number | null;
95
+ provider_uid?: string | null;
96
+ parent_id?: string | null;
97
+ dimension_id: string;
98
+ is_default: boolean;
99
+ effective_rule_id?: number | null;
100
+ has_children?: boolean;
101
+ children?: Array<AccountingDimensionValueWithChildren>;
102
+ };
103
+ type AccountingDimensionValueWithRules = {
104
+ id?: string | null;
105
+ value: string;
106
+ subsidiary_id?: number | null;
107
+ provider_uid?: string | null;
108
+ parent_id?: string | null;
109
+ dimension_id: string;
110
+ is_default: boolean;
111
+ effective_rule_id?: number | null;
112
+ has_children?: boolean;
113
+ rules?: Array<AccountingDimensionRuleCreateUpdate>;
114
+ };
115
+ type AccountingDimensionValueWithRulesAndChildren = {
116
+ id?: string | null;
117
+ value: string;
118
+ subsidiary_id?: number | null;
119
+ provider_uid?: string | null;
120
+ parent_id?: string | null;
121
+ dimension_id: string;
122
+ is_default: boolean;
123
+ effective_rule_id?: number | null;
124
+ has_children?: boolean;
125
+ children?: Array<AccountingDimensionValueWithChildren>;
126
+ rules?: Array<AccountingDimensionRuleCreateUpdate>;
127
+ };
128
+ type AccountingDimensionWithRules = {
129
+ name: string;
130
+ description?: string | null;
131
+ id: string;
132
+ is_default?: boolean;
133
+ values?: Array<AccountingDimensionValueWithRules>;
134
+ };
135
+ type AccountingExchangeRate = {
136
+ from_currency: AccountingCurrency;
137
+ to_currency: AccountingCurrency;
138
+ rate: number;
139
+ };
140
+ type AccountingExchangeRates = {
141
+ base_currency: AccountingCurrency;
142
+ rates: {
143
+ [key: string]: number;
144
+ };
145
+ exchange_date?: string;
146
+ };
147
+ type AccountingGroupTransaction = {
148
+ transaction_id: number;
149
+ journal_entry_id: string;
150
+ elimination_entry_id?: string | null;
151
+ id: number;
152
+ };
153
+ type AccountingGroupedAccounts = {
154
+ group_id: string;
155
+ group_name: string;
156
+ group_type: AccountingCoAGroupBy;
157
+ primary_balance?: AccountingBalanceOutput;
158
+ credit_primary_balance?: AccountingBalanceOutput;
159
+ debit_primary_balance?: AccountingBalanceOutput;
160
+ accounts: Array<AccountingTAccountOutput>;
161
+ };
162
+ type AccountingJeWriteBackStatus = 'syncing' | 'synced' | 'partial_success' | 'success' | 'failure';
163
+ type AccountingJournalEntry = {
164
+ created_from: string;
165
+ currency: AccountingCurrency;
166
+ memo?: string | null;
167
+ create_time?: string;
168
+ transaction_date?: string | null;
169
+ posting_date?: string | null;
170
+ is_adjustment?: boolean;
171
+ transaction_id?: number | null;
172
+ status?: AccountingJournalEntryStatus;
173
+ exchange_rates?: Array<AccountingExchangeRate>;
174
+ id: string;
175
+ subsidiary_id: number;
176
+ provider_uid: string;
177
+ ref_number?: string | null;
178
+ insert_time?: string;
179
+ clearing_group_id?: number | null;
180
+ is_nominal_ledger?: boolean;
181
+ sub_ledger?: AccountingSubLedger | null;
182
+ gl_entry_id?: string | null;
183
+ reconciled?: boolean | null;
184
+ source_entity?: AccountingJournalEntrySource | null;
185
+ provider_url?: string | null;
186
+ posting_period_id?: string | null;
187
+ syncing_status?: AccountingWriteBackStatusOutput | null;
188
+ group_transaction?: AccountingGroupTransaction | null;
189
+ reverse_entry_id?: string | null;
190
+ };
191
+ type AccountingJournalEntryDimensionsWithOperationCtx = {
192
+ lines?: Array<AccountingJournalEntryLineWithDimensionValuesOutput>;
193
+ created_from: string;
194
+ currency: AccountingCurrency;
195
+ memo?: string | null;
196
+ create_time?: string;
197
+ transaction_date?: string | null;
198
+ posting_date?: string | null;
199
+ is_adjustment?: boolean;
200
+ transaction_id?: number | null;
201
+ status?: AccountingJournalEntryStatus;
202
+ exchange_rates?: Array<AccountingExchangeRate>;
203
+ id: string;
204
+ subsidiary_id: number;
205
+ provider_uid: string;
206
+ ref_number?: string | null;
207
+ insert_time?: string;
208
+ clearing_group_id?: number | null;
209
+ is_nominal_ledger?: boolean;
210
+ sub_ledger?: AccountingSubLedger | null;
211
+ gl_entry_id?: string | null;
212
+ reconciled?: boolean | null;
213
+ source_entity?: AccountingJournalEntrySource | null;
214
+ provider_url?: string | null;
215
+ posting_period_id?: string | null;
216
+ syncing_status?: AccountingWriteBackStatusOutput | null;
217
+ group_transaction?: AccountingGroupTransaction | null;
218
+ reverse_entry_id?: string | null;
219
+ can_sync_to_provider?: boolean;
220
+ sync_to_provider_reason?: string | null;
221
+ can_edit?: boolean;
222
+ };
223
+ type AccountingJournalEntryLinePaginationOutput = {
224
+ results?: Array<AccountingJournalEntryLineWithJournalEntryWithDimensionsWithOperationCtx>;
225
+ pagination: AccountingPaginationOutput | null;
226
+ };
227
+ type AccountingJournalEntryLineWithDimensionValuesOutput = {
228
+ id: string;
229
+ account_id: string;
230
+ journal_entry_id: string;
231
+ line_num: number;
232
+ is_debit: boolean;
233
+ account_provider_id?: string | null;
234
+ account?: AccountingTAccountWithoutSubsidiaryMappingOutput | null;
235
+ total_amount?: number;
236
+ primary_currency_amount?: number;
237
+ secondary_currency_amount?: number;
238
+ tertiary_currency_amount?: number;
239
+ subsidiary_id?: number | null;
240
+ create_time?: string | null;
241
+ transaction_date?: string | null;
242
+ memo?: string | null;
243
+ provider_property?: string | null;
244
+ is_for_elimination?: boolean;
245
+ recurring_transaction_id?: string | null;
246
+ transaction_number?: string | null;
247
+ po_number?: string | null;
248
+ sales_order_ref?: string | null;
249
+ invoice_ref?: string | null;
250
+ extra_reference?: string | null;
251
+ assignment_ref?: string | null;
252
+ dimension_values?: Array<AccountingLineDimensionEffectiveAssignmentOutput | AccountingDimensionValue>;
253
+ };
254
+ type AccountingJournalEntryLineWithJournalEntryWithDimensionsWithOperationCtx = {
255
+ id: string;
256
+ account_id: string;
257
+ journal_entry_id: string;
258
+ line_num: number;
259
+ is_debit: boolean;
260
+ account_provider_id?: string | null;
261
+ account?: AccountingTAccountWithoutSubsidiaryMappingOutput | null;
262
+ total_amount?: number;
263
+ primary_currency_amount?: number;
264
+ secondary_currency_amount?: number;
265
+ tertiary_currency_amount?: number;
266
+ subsidiary_id?: number | null;
267
+ create_time?: string | null;
268
+ transaction_date?: string | null;
269
+ memo?: string | null;
270
+ provider_property?: string | null;
271
+ is_for_elimination?: boolean;
272
+ recurring_transaction_id?: string | null;
273
+ transaction_number?: string | null;
274
+ po_number?: string | null;
275
+ sales_order_ref?: string | null;
276
+ invoice_ref?: string | null;
277
+ extra_reference?: string | null;
278
+ assignment_ref?: string | null;
279
+ journal_entry?: AccountingJournalEntry | null;
280
+ dimension_values?: Array<AccountingLineDimensionEffectiveAssignmentOutput | AccountingDimensionValue>;
281
+ can_sync_to_provider?: boolean;
282
+ sync_to_provider_reason?: string | null;
283
+ can_edit?: boolean;
284
+ };
285
+ type AccountingJournalEntryPaginationOutput = {
286
+ results?: Array<AccountingJournalEntryDimensionsWithOperationCtx>;
287
+ pagination: AccountingPaginationOutput | null;
288
+ };
289
+ type AccountingJournalEntrySource = 'Elimination' | 'Journal Entry' | 'Bill' | 'Lease' | 'Invoice' | 'Bill Payment';
290
+ type AccountingJournalEntryStatus = 'Posted' | 'Draft' | 'Submitted';
291
+ type AccountingJournalEntryType = 'adjustment' | 'elimination' | 'book_entry' | 'ic_transaction';
292
+ type AccountingLineDimensionEffectiveAssignmentOutput = {
293
+ journal_line_id: string;
294
+ dimension_id?: string | null;
295
+ dimension_value_id?: string | null;
296
+ effective_rule_id?: number | null;
297
+ dimension_value_override_id?: number | null;
298
+ dimension_value?: AccountingDimensionValue | null;
299
+ effective_rule?: AccountingLibcommonModelsAccountingDimensionsDimensionRuleOutput | null;
300
+ dimension_value_override?: AccountingLineDimensionValueOverride | null;
301
+ };
302
+ type AccountingLineDimensionValueOverride = {
303
+ dimension_id: string;
304
+ dimension_value_id: string;
305
+ journal_line_id: string;
306
+ override_source?: AccountingDimensionValueOverrideSource;
307
+ id: number;
308
+ dimension_value?: AccountingDimensionValue | null;
309
+ };
310
+ type AccountingMappedNominalAccount = {
311
+ id: string;
312
+ name: string;
313
+ hierarchy_account_name: string;
314
+ account_type: AccountingAccountType;
315
+ account_number?: string | null;
316
+ };
317
+ type AccountingPaginationOutput = {
318
+ page?: number | null;
319
+ per_page?: number | null;
320
+ include_total?: boolean;
321
+ position?: AccountingPaginationPositionInput | null;
322
+ pages?: number | null;
323
+ total?: number | null;
324
+ };
325
+ type AccountingPaginationPositionInput = {
326
+ start: number;
327
+ end: number;
328
+ };
329
+ type AccountingPeriod = 'Annual' | 'Quarterly' | 'Monthly';
330
+ type AccountingProviderOperationErrorType = 'Connection Error' | 'Authentication Error' | 'Data Operation Error' | 'Server Error' | 'Not Ready For Sync';
331
+ type AccountingSimpleCoAPaginationOutput = {
332
+ results: Array<AccountingSimpleTAccount>;
333
+ pagination?: AccountingPaginationOutput | null;
334
+ };
335
+ type AccountingSimpleTAccount = {
336
+ id: string;
337
+ name: string;
338
+ subsidiary_id: number;
339
+ accounting_class: AccountingAccountingClass;
340
+ account_type: AccountingAccountType;
341
+ account_number?: string | null;
342
+ };
343
+ type AccountingSortableFieldsCer = 'month' | 'from_subsidiary' | 'to_subsidiary';
344
+ type AccountingSortableFieldsCoa = 'name' | 'create_time' | 'account_number';
345
+ type AccountingSortingOrder = 'asc' | 'desc';
346
+ type AccountingSubLedger = 'lease' | 'prepaid_expense';
347
+ type AccountingTAccountOutput = {
348
+ id: string;
349
+ name: string;
350
+ report_category?: AccountingAccountReportCategory | null;
351
+ accounting_class: AccountingAccountingClass;
352
+ account_type: AccountingAccountType;
353
+ account_rate_type?: AccountingConsolidationExchangeRateType | null;
354
+ account_number?: string | null;
355
+ parent_account_id?: string | null;
356
+ active?: boolean;
357
+ summary?: boolean;
358
+ read_only?: boolean;
359
+ is_manually_created?: boolean;
360
+ provider_id: string;
361
+ subsidiary_id: number;
362
+ currency?: AccountingCurrency;
363
+ sourced_account_id?: string | null;
364
+ account_balance?: AccountingBalanceOutput;
365
+ primary_balance?: AccountingBalanceOutput;
366
+ secondary_balance?: AccountingBalanceOutput;
367
+ cta_balance?: AccountingBalanceOutput;
368
+ credit_account_balance?: AccountingBalanceOutput;
369
+ debit_account_balance?: AccountingBalanceOutput;
370
+ credit_primary_balance?: AccountingBalanceOutput;
371
+ debit_primary_balance?: AccountingBalanceOutput;
372
+ credit_secondary_balance?: AccountingBalanceOutput;
373
+ debit_secondary_balance?: AccountingBalanceOutput;
374
+ credit_cta_balance?: AccountingBalanceOutput;
375
+ debit_cta_balance?: AccountingBalanceOutput;
376
+ tertiary_debit?: AccountingBalanceOutput | null;
377
+ tertiary_credit?: AccountingBalanceOutput | null;
378
+ create_time?: string;
379
+ last_update_time?: string;
380
+ description?: string | null;
381
+ meta?: {
382
+ [key: string]: unknown;
383
+ } | null;
384
+ nominal_account?: AccountingMappedNominalAccount | null;
385
+ account_subsidiaries_ids?: Array<number>;
386
+ };
387
+ type AccountingTAccountWithSubAccounts = {
388
+ id: string;
389
+ name: string;
390
+ report_category?: AccountingAccountReportCategory | null;
391
+ accounting_class: AccountingAccountingClass;
392
+ account_type: AccountingAccountType;
393
+ account_rate_type?: AccountingConsolidationExchangeRateType | null;
394
+ account_number?: string | null;
395
+ parent_account_id?: string | null;
396
+ active?: boolean;
397
+ summary?: boolean;
398
+ read_only?: boolean;
399
+ is_manually_created?: boolean;
400
+ provider_id: string;
401
+ subsidiary_id: number;
402
+ currency?: AccountingCurrency;
403
+ sourced_account_id?: string | null;
404
+ account_balance?: AccountingBalanceOutput;
405
+ primary_balance?: AccountingBalanceOutput;
406
+ secondary_balance?: AccountingBalanceOutput;
407
+ cta_balance?: AccountingBalanceOutput;
408
+ credit_account_balance?: AccountingBalanceOutput;
409
+ debit_account_balance?: AccountingBalanceOutput;
410
+ credit_primary_balance?: AccountingBalanceOutput;
411
+ debit_primary_balance?: AccountingBalanceOutput;
412
+ credit_secondary_balance?: AccountingBalanceOutput;
413
+ debit_secondary_balance?: AccountingBalanceOutput;
414
+ credit_cta_balance?: AccountingBalanceOutput;
415
+ debit_cta_balance?: AccountingBalanceOutput;
416
+ tertiary_debit?: AccountingBalanceOutput | null;
417
+ tertiary_credit?: AccountingBalanceOutput | null;
418
+ create_time?: string;
419
+ last_update_time?: string;
420
+ description?: string | null;
421
+ meta?: {
422
+ [key: string]: unknown;
423
+ } | null;
424
+ nominal_account?: AccountingMappedNominalAccount | null;
425
+ account_subsidiaries_ids?: Array<number>;
426
+ sub_accounts?: Array<AccountingTAccountWithSubAccounts>;
427
+ };
428
+ type AccountingTAccountWithoutSubsidiaryMappingOutput = {
429
+ id: string;
430
+ name: string;
431
+ report_category?: AccountingAccountReportCategory | null;
432
+ accounting_class: AccountingAccountingClass;
433
+ account_type: AccountingAccountType;
434
+ account_rate_type?: AccountingConsolidationExchangeRateType | null;
435
+ account_number?: string | null;
436
+ parent_account_id?: string | null;
437
+ active?: boolean;
438
+ summary?: boolean;
439
+ read_only?: boolean;
440
+ is_manually_created?: boolean;
441
+ provider_id: string;
442
+ subsidiary_id: number;
443
+ currency?: AccountingCurrency;
444
+ sourced_account_id?: string | null;
445
+ account_balance?: AccountingBalanceOutput;
446
+ primary_balance?: AccountingBalanceOutput;
447
+ secondary_balance?: AccountingBalanceOutput;
448
+ cta_balance?: AccountingBalanceOutput;
449
+ credit_account_balance?: AccountingBalanceOutput;
450
+ debit_account_balance?: AccountingBalanceOutput;
451
+ credit_primary_balance?: AccountingBalanceOutput;
452
+ debit_primary_balance?: AccountingBalanceOutput;
453
+ credit_secondary_balance?: AccountingBalanceOutput;
454
+ debit_secondary_balance?: AccountingBalanceOutput;
455
+ credit_cta_balance?: AccountingBalanceOutput;
456
+ debit_cta_balance?: AccountingBalanceOutput;
457
+ tertiary_debit?: AccountingBalanceOutput | null;
458
+ tertiary_credit?: AccountingBalanceOutput | null;
459
+ create_time?: string;
460
+ last_update_time?: string;
461
+ description?: string | null;
462
+ meta?: {
463
+ [key: string]: unknown;
464
+ } | null;
465
+ nominal_account?: AccountingMappedNominalAccount | null;
466
+ };
467
+ type AccountingWriteBackStatusOutput = {
468
+ id: string;
469
+ transaction_id: string;
470
+ journal_entry_id: string;
471
+ status: AccountingJeWriteBackStatus;
472
+ provider_uid?: string | null;
473
+ error_message?: string | null;
474
+ error_type?: AccountingProviderOperationErrorType | null;
475
+ last_modified_time?: string | null;
476
+ readonly display_error_message: string;
477
+ };
478
+ type AccountingLibcommonModelsAccountingDimensionsDimensionRuleOutput = {
479
+ dimension_id: string;
480
+ order: number;
481
+ dimension_value_id: string;
482
+ name: string;
483
+ subsidiary_id?: number | null;
484
+ by_account_code?: Array<string> | null;
485
+ by_account_name?: string | null;
486
+ by_account_ids?: Array<string> | null;
487
+ by_account_types?: Array<AccountingAccountType> | null;
488
+ by_journal_entry_memo?: string | null;
489
+ by_journal_entry_created_from?: string | null;
490
+ by_journal_entry_line_memo?: string | null;
491
+ by_journal_entry_line_property?: string | null;
492
+ by_dimension_value_ids?: Array<string> | null;
493
+ by_empty_dimension_id_values?: Array<string> | null;
494
+ id: number;
495
+ dimension: AccountingDimension;
496
+ dimension_value: AccountingDimensionValue;
497
+ accounts?: Array<AccountingTAccountWithoutSubsidiaryMappingOutput>;
498
+ };
499
+ /**
500
+ * API representation of EnrichedActivityInstance.
501
+ *
502
+ * Uses APIPeriodInstanceCreate instead of PeriodInstanceCreate to avoid
503
+ * dependency on TenantContext during serialization.
504
+ */
505
+ type ActivityApiEnrichedActivityInstance = {
506
+ last_manually_updated?: string | null;
507
+ created_at?: string | null;
508
+ last_modified_at?: string | null;
509
+ id: string;
510
+ name: string;
511
+ due_date: string;
512
+ period_instance_id: string;
513
+ activity_definition_id: string;
514
+ is_deleted?: boolean;
515
+ description?: string | null;
516
+ reconciliation_status?: ActivityReconciliationStatus;
517
+ preparer_id?: string | null;
518
+ reviewer_id?: string | null;
519
+ task_instances?: Array<ActivityTaskInstanceWithAction>;
520
+ period_instance: ActivityApiPeriodInstanceCreate;
521
+ activity_definition: ActivityActivityDefinitionCreateWithType;
522
+ readonly assignees: Array<string>;
523
+ progress: ActivityTasksProgress;
524
+ readonly ready_to_reconcile: boolean;
525
+ status: ActivityActivityStatus;
526
+ };
527
+ type ActivityApiJournalEntryInput = {
528
+ lines?: Array<ActivityApiJournalEntryLineInput>;
529
+ currency: ActivityCurrency;
530
+ exchange_rates?: Array<ActivityExchangeRate>;
531
+ create_time: string;
532
+ subsidiary_id?: number | null;
533
+ sub_ledger?: ActivitySubLedger | null;
534
+ entry_type?: ActivityJournalEntryType | null;
535
+ memo?: string | null;
536
+ is_adjustment?: boolean | null;
537
+ clearing_group_id?: number | null;
538
+ transaction_id?: number | null;
539
+ status?: ActivityJournalEntryStatus | null;
540
+ reverse_date?: string | null;
541
+ id?: string | null;
542
+ };
543
+ type ActivityApiJournalEntryOutput = {
544
+ lines?: Array<ActivityApiJournalEntryLineOutput>;
545
+ currency: ActivityCurrency;
546
+ exchange_rates?: Array<ActivityExchangeRate>;
547
+ create_time: string;
548
+ subsidiary_id?: number | null;
549
+ sub_ledger?: ActivitySubLedger | null;
550
+ entry_type?: ActivityJournalEntryType | null;
551
+ memo?: string | null;
552
+ is_adjustment?: boolean | null;
553
+ clearing_group_id?: number | null;
554
+ transaction_id?: number | null;
555
+ status?: ActivityJournalEntryStatus | null;
556
+ reverse_date?: string | null;
557
+ id?: string | null;
558
+ };
559
+ type ActivityApiJournalEntryLineInput = {
560
+ account_id: string;
561
+ amount: number;
562
+ is_debit: boolean;
563
+ memo?: string | null;
564
+ dimension_values?: Array<ActivityLineDimensionEffectiveAssignmentInput | ActivityDimensionValue>;
565
+ is_for_elimination?: boolean | null;
566
+ subsidiary_id?: number | null;
567
+ };
568
+ type ActivityApiJournalEntryLineOutput = {
569
+ account_id: string;
570
+ amount: number;
571
+ is_debit: boolean;
572
+ memo?: string | null;
573
+ dimension_values?: Array<ActivityLineDimensionEffectiveAssignmentOutput | ActivityDimensionValue>;
574
+ is_for_elimination?: boolean | null;
575
+ subsidiary_id?: number | null;
576
+ };
577
+ /**
578
+ * API representation of PeriodInstanceCreate.
579
+ *
580
+ * Uses a plain 'display_id' field instead of a computed property to avoid
581
+ * dependency on TenantContext during serialization.
582
+ */
583
+ type ActivityApiPeriodInstanceCreate = {
584
+ id: string;
585
+ period: ActivityPeriod;
586
+ start_date: string;
587
+ end_date: string;
588
+ name: string;
589
+ display_id: string;
590
+ };
591
+ type ActivityAccountReconciliationParams = {
592
+ reconciliation_type?: 'account_reconciliation';
593
+ gl_account_id: string;
594
+ };
595
+ type ActivityAccountReportCategory = 'Balance Sheet' | 'P&L';
596
+ type ActivityAccountType = 'Bank' | 'Current Asset' | 'Non-current Asset' | 'Fixed Asset' | 'Depreciation' | 'Inventory' | 'Prepayment' | 'Undeposited Funds' | 'Other Assets' | 'Accounts Receivable' | 'CTA' | 'Equity' | 'Retained Earnings' | 'Other Equity' | 'Expense' | 'Other Expense' | 'Cost of Goods Sold' | 'Wages Expense' | 'Interest Expense' | 'Taxes Expense' | 'Depreciation Expense' | 'Amortization Expense' | 'Overhead' | 'Accounts Payable' | 'Credit Card' | 'Non-current Liability' | 'Current Liability' | 'Deferred Revenue' | 'Other Liability' | 'Revenue' | 'Sales' | 'Other Income' | 'Other Revenue' | 'Statistical';
597
+ type ActivityAccountingClass = 'Asset' | 'Equity' | 'Liability' | 'Revenue' | 'Expense' | 'Statistical';
598
+ type ActivityActivityDefinitionCreateWithType = {
599
+ created_at?: string | null;
600
+ last_modified_at?: string | null;
601
+ name: string;
602
+ due_date: ActivityDueDate;
603
+ enabled?: boolean;
604
+ description?: string | null;
605
+ preparer_id?: string | null;
606
+ reviewer_id?: string | null;
607
+ frequency: ActivityPeriod;
608
+ id?: string;
609
+ predefined?: boolean;
610
+ from_date_override?: string | null;
611
+ type?: ActivityActivityType | null;
612
+ is_deleted?: boolean;
613
+ };
614
+ type ActivityActivityInstance = {
615
+ last_manually_updated?: string | null;
616
+ created_at?: string | null;
617
+ last_modified_at?: string | null;
618
+ id: string;
619
+ name: string;
620
+ due_date: string;
621
+ period_instance_id: string;
622
+ activity_definition_id: string;
623
+ is_deleted?: boolean;
624
+ description?: string | null;
625
+ reconciliation_status?: ActivityReconciliationStatus;
626
+ preparer_id?: string | null;
627
+ reviewer_id?: string | null;
628
+ };
629
+ type ActivityActivityInstanceWithTaskInstances = {
630
+ last_manually_updated?: string | null;
631
+ created_at?: string | null;
632
+ last_modified_at?: string | null;
633
+ id: string;
634
+ name: string;
635
+ due_date: string;
636
+ period_instance_id: string;
637
+ activity_definition_id: string;
638
+ is_deleted?: boolean;
639
+ description?: string | null;
640
+ reconciliation_status?: ActivityReconciliationStatus;
641
+ preparer_id?: string | null;
642
+ reviewer_id?: string | null;
643
+ task_instances?: Array<ActivityTaskInstanceWithAction>;
644
+ readonly assignees: Array<string>;
645
+ progress: ActivityTasksProgress;
646
+ readonly ready_to_reconcile: boolean;
647
+ status: ActivityActivityStatus;
648
+ };
649
+ type ActivityActivityStatus = 'OPEN' | 'CLOSED';
650
+ /**
651
+ * Progress for an activity broken down by subsidiaries.
652
+ */
653
+ type ActivityActivitySubsidiaryProgress = {
654
+ activity_instance_id: string;
655
+ activity_name: string;
656
+ progress: ActivityTasksProgress;
657
+ subsidiaries?: Array<ActivitySubsidiaryProgress>;
658
+ };
659
+ type ActivityActivityType = 'Leases' | 'Prepaid Expenses';
660
+ type ActivityBalanceInput = {
661
+ round_balance?: boolean;
662
+ balance?: number;
663
+ currency?: ActivityCurrency | null;
664
+ };
665
+ type ActivityBalanceOutput = {
666
+ balance?: number;
667
+ currency?: ActivityCurrency | null;
668
+ };
669
+ type ActivityBaseTaskInstanceWithAction = {
670
+ last_manually_updated?: string | null;
671
+ created_at?: string | null;
672
+ last_modified_at?: string | null;
673
+ id: string;
674
+ name: string;
675
+ due_date: string;
676
+ preparer_due_date: string;
677
+ status: ActivityTaskStatus;
678
+ description?: string | null;
679
+ task_definition_id: string;
680
+ activity_instance_id: string;
681
+ subsidiary_id: number;
682
+ is_deleted?: boolean;
683
+ preparer_id?: string | null;
684
+ assignee_id?: string | null;
685
+ reconciled?: boolean | null;
686
+ creator?: ActivityTaskCreator | null;
687
+ decline_reason?: string | null;
688
+ trigger_execution_id?: string | null;
689
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
690
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
691
+ is_currently_blocked?: boolean | null;
692
+ is_blocking_manually_set?: boolean;
693
+ task_type?: ActivityTaskType | null;
694
+ attachments_count?: number;
695
+ task_action?: ActivityTaskActionOutput | null;
696
+ task_action_type?: string | null;
697
+ is_manual_task?: boolean | null;
698
+ activity_name?: string | null;
699
+ period_display_id?: string | null;
700
+ activity_definition_id?: string | null;
701
+ task_action_execution_errors?: Array<ActivityTaskActionExecutionError> | null;
702
+ };
703
+ type ActivityBillCreate = {
704
+ subsidiary_id: number;
705
+ create_time: string;
706
+ posting_date: string;
707
+ due_date: string;
708
+ amount: number;
709
+ currency?: ActivityCurrency;
710
+ vendor_id: string;
711
+ status: ActivityBillStatus;
712
+ reference_number?: string | null;
713
+ bill_number?: string | null;
714
+ memo?: string | null;
715
+ id: string;
716
+ provider_uid: string;
717
+ source_entity?: ActivityBillSourceEntity | null;
718
+ source_entity_id?: string | null;
719
+ original_id?: string | null;
720
+ journal_entry_id?: string | null;
721
+ is_nominal?: boolean;
722
+ };
723
+ type ActivityBillDataInput = {
724
+ bill: ActivityBillCreate;
725
+ bill_items: Array<ActivityBillItemCreate>;
726
+ dimension_value_ids?: Array<string>;
727
+ };
728
+ type ActivityBillDataOutput = {
729
+ bill: ActivityBillCreate;
730
+ bill_items: Array<ActivityBillItemCreate>;
731
+ dimension_value_ids?: Array<string>;
732
+ };
733
+ type ActivityBillItemCreate = {
734
+ subsidiary_id: number;
735
+ amount: number;
736
+ account_id: string;
737
+ ap_account_id: string;
738
+ memo?: string | null;
739
+ id: string;
740
+ provider_uid: string;
741
+ bill_id: string;
742
+ item_number: number;
743
+ is_nominal?: boolean;
744
+ };
745
+ type ActivityBillSourceEntity = 'lease';
746
+ type ActivityBillStatus = 'draft' | 'posted' | 'submitted';
747
+ type ActivityBillUpdateBase = {
748
+ posting_date?: string | null;
749
+ due_date?: string | null;
750
+ amount?: number | null;
751
+ currency?: ActivityCurrency | null;
752
+ vendor_id?: string | null;
753
+ reference_number?: string | null;
754
+ bill_number?: string | null;
755
+ memo?: string | null;
756
+ original_id?: string | null;
757
+ };
758
+ type ActivityBlockingScope = 'GLOBAL' | 'SUBSIDIARY';
759
+ type ActivityBodyGetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPost = {
760
+ due_date_timeframe?: ActivityTimeframe | null;
761
+ status?: Array<ActivityTaskStatus>;
762
+ subsidiary_ids?: Array<number>;
763
+ activity_definition_ids?: Array<string>;
764
+ preparer_ids?: Array<string> | null;
765
+ reviewer_ids?: Array<string> | null;
766
+ pagination_in?: ActivityPaginationInput | null;
767
+ search?: ActivityTaskInstanceSearch | null;
768
+ period_instance_id?: string | null;
769
+ period_display_id?: string | null;
770
+ period_instance_ids?: Array<string> | null;
771
+ period_display_ids?: Array<string> | null;
772
+ exclude_task_types?: Array<ActivityTaskType> | null;
773
+ slim?: boolean;
774
+ entity_ids?: Array<string>;
775
+ entity_type?: ActivityTaskEntityType | null;
776
+ with_entities?: boolean;
777
+ };
778
+ type ActivityConsolidationExchangeRateType = 'current' | 'average' | 'historical';
779
+ type ActivityCreateBillTaskActionDataInput = {
780
+ action_type?: 'create_bill';
781
+ bill_data: ActivityBillDataInput;
782
+ };
783
+ type ActivityCreateBillTaskActionDataOutput = {
784
+ action_type?: 'create_bill';
785
+ bill_data: ActivityBillDataOutput;
786
+ };
787
+ type ActivityCreateIctEliminationActionTemplateInput = {
788
+ action_type?: 'create_ict_elimination_entries';
789
+ ict_elimination_data: ActivityIctEliminationDataInput;
790
+ };
791
+ type ActivityCreateIctEliminationActionTemplateOutput = {
792
+ action_type?: 'create_ict_elimination_entries';
793
+ ict_elimination_data: ActivityIctEliminationDataOutput;
794
+ };
795
+ type ActivityCreateIctEliminationTaskActionDataInput = {
796
+ action_type?: 'create_ict_elimination_entries';
797
+ ict_elimination_data: ActivityIctEliminationDataInput;
798
+ };
799
+ type ActivityCreateIctEliminationTaskActionDataOutput = {
800
+ action_type?: 'create_ict_elimination_entries';
801
+ ict_elimination_data: ActivityIctEliminationDataOutput;
802
+ };
803
+ type ActivityCreateJournalEntriesActionTemplateInput = {
804
+ action_type?: 'create_journal_entries';
805
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesInput>;
806
+ };
807
+ type ActivityCreateJournalEntriesActionTemplateOutput = {
808
+ action_type?: 'create_journal_entries';
809
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesOutput>;
810
+ };
811
+ type ActivityCreateJournalEntriesBulkActionTemplateInput = {
812
+ action_type?: 'create_journal_entries_bulk';
813
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesInput | ActivityApiJournalEntryInput>;
814
+ };
815
+ type ActivityCreateJournalEntriesBulkActionTemplateOutput = {
816
+ action_type?: 'create_journal_entries_bulk';
817
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesOutput | ActivityApiJournalEntryOutput>;
818
+ };
819
+ type ActivityCreateJournalEntriesBulkTaskActionDataInput = {
820
+ action_type?: 'create_journal_entries_bulk';
821
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesInput>;
822
+ };
823
+ type ActivityCreateJournalEntriesBulkTaskActionDataOutput = {
824
+ action_type?: 'create_journal_entries_bulk';
825
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesOutput>;
826
+ };
827
+ type ActivityCreateJournalEntryActionTemplateInput = {
828
+ action_type?: 'create_journal_entry';
829
+ journal_entry_data: ActivityJournalEntryWithLinesWithDimensionValuesInput | ActivityApiJournalEntryInput;
830
+ reverse_date?: string | null;
831
+ };
832
+ type ActivityCreateJournalEntryActionTemplateOutput = {
833
+ action_type?: 'create_journal_entry';
834
+ journal_entry_data: ActivityJournalEntryWithLinesWithDimensionValuesOutput | ActivityApiJournalEntryOutput;
835
+ reverse_date?: string | null;
836
+ };
837
+ type ActivityCreateJournalEntryScheduleActionTemplateInput = {
838
+ action_type?: 'create_journal_entry_schedule';
839
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesInput>;
840
+ due_date: ActivityDueDate;
841
+ schedule_name: string;
842
+ };
843
+ type ActivityCreateJournalEntryScheduleActionTemplateOutput = {
844
+ action_type?: 'create_journal_entry_schedule';
845
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesOutput>;
846
+ due_date: ActivityDueDate;
847
+ schedule_name: string;
848
+ };
849
+ type ActivityCreateJournalEntryTaskActionDataInput = {
850
+ action_type?: 'create_journal_entry';
851
+ journal_entry_data: ActivityJournalEntryWithLinesWithDimensionValuesInput | ActivityApiJournalEntryInput;
852
+ reverse_date?: string | null;
853
+ };
854
+ type ActivityCreateJournalEntryTaskActionDataOutput = {
855
+ action_type?: 'create_journal_entry';
856
+ journal_entry_data: ActivityJournalEntryWithLinesWithDimensionValuesOutput | ActivityApiJournalEntryOutput;
857
+ reverse_date?: string | null;
858
+ };
859
+ type ActivityCreateJournalEntryTaskScheduleActionDataInput = {
860
+ action_type?: 'create_journal_entry_schedule';
861
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesInput>;
862
+ due_date: ActivityDueDate;
863
+ schedule_name: string;
864
+ };
865
+ type ActivityCreateJournalEntryTaskScheduleActionDataOutput = {
866
+ action_type?: 'create_journal_entry_schedule';
867
+ journal_entries: Array<ActivityJournalEntryWithLinesWithDimensionValuesOutput>;
868
+ due_date: ActivityDueDate;
869
+ schedule_name: string;
870
+ };
871
+ type ActivityCreateLockPeriodTaskActionDataInput = {
872
+ action_type?: 'lock_consolidation_period';
873
+ period_data: ActivityPeriodData;
874
+ };
875
+ type ActivityCreateLockPeriodTaskActionDataOutput = {
876
+ action_type?: 'lock_consolidation_period';
877
+ period_data: ActivityPeriodData;
878
+ };
879
+ type ActivityCurrency = 'United States Dollar' | 'Euro' | 'British Pound Sterling' | 'Indian Rupee' | 'Australian Dollar' | 'Canadian Dollar' | 'New Israeli Shekel' | 'Japanese Yen' | 'Sri Lankan Rupee' | 'New Zealand Dollar' | 'Swedish Krona' | 'South African Rand' | 'Singapore Dollar' | 'Indonesian Rupiah' | 'Danish Krone' | 'Hong Kong Dollar' | 'United Arab Emirates Dirham' | 'Argentine Peso' | 'Brazilian Real' | 'Bulgarian Lev' | 'Chinese Yuan' | 'Colombian Peso' | 'Czech Koruna' | 'Malaysian Ringgit' | 'Mexican Peso' | 'Myanmar Kyat' | 'New Taiwan Dollar' | 'Norwegian Krone' | 'Omani Rial' | 'Philippine Peso' | 'Polish Zloty' | 'Romanian Leu' | 'Swiss Franc' | 'Turkish Lira' | 'Serbian Dinar' | 'Hungarian Forint' | 'South Korean Won' | 'Armenian Dram' | 'Azerbaijani Manat' | 'Bahraini Dinar' | 'Chilean Peso' | 'Fijian Dollar' | 'Georgian Lari' | 'Guatemalan Quetzal' | 'Croatian Kuna' | 'Icelandic Krona' | 'Jordanian Dinar' | 'Kyrgyzstani Som' | 'Kuwaiti Dinar' | 'Kazakhstani Tenge' | 'Moroccan Dirham' | 'Papua New Guinean Kina' | 'Qatari Rial' | 'Russian Ruble' | 'Saudi Riyal' | 'Thai Baht' | 'Somali Shilling' | 'Tunisian Dinar' | 'Ukrainian Hryvnia' | 'Uzbekistani Som' | 'Vietnamese Dong' | 'Central African CFA Franc' | 'Afghani' | 'Lek' | 'Kwanza' | 'Aruban Florin' | 'Convertible Mark' | 'Barbados Dollar' | 'Taka' | 'Burundi Franc' | 'Bermudian Dollar' | 'Brunei Dollar' | 'Boliviano' | 'Mvdol' | 'Bahamian Dollar' | 'Ngultrum' | 'Pula' | 'Belarusian Ruble' | 'Belize Dollar' | 'Congolese Franc' | 'WIR Euro' | 'WIR Franc' | 'Unidad de Fomento' | 'Unidad de Valor Real' | 'Costa Rican Colon' | 'Cuban Peso' | 'Cabo Verde Escudo' | 'Djibouti Franc' | 'Dominican Peso' | 'Algerian Dinar' | 'Egyptian Pound' | 'Nakfa' | 'Ethiopian Birr' | 'Falkland Islands Pound' | 'Ghana Cedi' | 'Gibraltar Pound' | 'Dalasi' | 'Guinean Franc' | 'Guyana Dollar' | 'Lempira' | 'Gourde' | 'Iraqi Dinar' | 'Iranian Rial' | 'Jamaican Dollar' | 'Kenyan Shilling' | 'Riel' | 'Comorian Franc' | 'North Korean Won' | 'Cayman Islands Dollar' | 'Lao Kip' | 'Lebanese Pound' | 'Liberian Dollar' | 'Loti' | 'Libyan Dinar' | 'Moldovan Leu' | 'Malagasy Ariary' | 'Denar' | 'Tugrik' | 'Pataca' | 'Ouguiya' | 'Mauritius Rupee' | 'Rufiyaa' | 'Malawi Kwacha' | 'Mexican Unidad de Inversion (UDI)' | 'Mozambique Metical' | 'Namibia Dollar' | 'Naira' | 'Cordoba Oro' | 'Nepalese Rupee' | 'Balboa' | 'Sol' | 'Pakistan Rupee' | 'Guarani' | 'Rwanda Franc' | 'Solomon Islands Dollar' | 'Seychelles Rupee' | 'Sudanese Pound' | 'Saint Helena Pound' | 'Leone' | 'Surinam Dollar' | 'South Sudanese Pound' | 'Dobra' | 'El Salvador Colon' | 'Syrian Pound' | 'Lilangeni' | 'Somoni' | 'Turkmenistan New Manat' | "Pa'anga" | 'Trinidad and Tobago Dollar' | 'Tanzanian Shilling' | 'Uganda Shilling' | 'US Dollar (Next day)' | 'Uruguay Peso en Unidades Indexadas (UI)' | 'Peso Uruguayo' | 'Unidad Previsional' | 'Bolivar Digital' | 'Bolivar Soberano' | 'Vatu' | 'Tala' | 'Arab Accounting Dinar' | 'Silver' | 'Gold' | 'Bond Markets Unit European Composite Unit (EURCO)' | 'Bond Markets Unit European Monetary Unit (E.M.U.-6)' | 'Bond Markets Unit European Unit of Account 9 (E.U.A.-9)' | 'Bond Markets Unit European Unit of Account 17 (E.U.A.-17)' | 'East Caribbean Dollar' | 'Caribbean Guilder' | 'SDR (Special Drawing Right)' | 'CFA Franc BCEAO' | 'Palladium' | 'CFP Franc' | 'Platinum' | 'Sucre' | 'Codes specifically reserved for testing purposes' | 'ADB Unit of Account' | 'The codes assigned for transactions where no currency is involved' | 'Yemeni Rial' | 'Zambian Kwacha' | 'Zimbabwe Gold';
880
+ type ActivityDeltaUnit = 'Days' | 'Weeks' | 'Weekdays';
881
+ type ActivityDimension = {
882
+ name: string;
883
+ description?: string | null;
884
+ id: string;
885
+ is_default?: boolean;
886
+ values?: Array<ActivityDimensionValue>;
887
+ };
888
+ type ActivityDimensionRuleInput = {
889
+ dimension_id: string;
890
+ order: number;
891
+ dimension_value_id: string;
892
+ name: string;
893
+ subsidiary_id?: number | null;
894
+ by_account_code?: Array<string> | null;
895
+ by_account_name?: string | null;
896
+ by_account_ids?: Array<string> | null;
897
+ by_account_types?: Array<ActivityAccountType> | null;
898
+ by_journal_entry_memo?: string | null;
899
+ by_journal_entry_created_from?: string | null;
900
+ by_journal_entry_line_memo?: string | null;
901
+ by_journal_entry_line_property?: string | null;
902
+ by_dimension_value_ids?: Array<string> | null;
903
+ by_empty_dimension_id_values?: Array<string> | null;
904
+ id: number;
905
+ dimension: ActivityDimension;
906
+ dimension_value: ActivityDimensionValue;
907
+ accounts?: Array<ActivityTAccountWithoutSubsidiaryMappingInput>;
908
+ };
909
+ type ActivityDimensionRuleOutput = {
910
+ dimension_id: string;
911
+ order: number;
912
+ dimension_value_id: string;
913
+ name: string;
914
+ subsidiary_id?: number | null;
915
+ by_account_code?: Array<string> | null;
916
+ by_account_name?: string | null;
917
+ by_account_ids?: Array<string> | null;
918
+ by_account_types?: Array<ActivityAccountType> | null;
919
+ by_journal_entry_memo?: string | null;
920
+ by_journal_entry_created_from?: string | null;
921
+ by_journal_entry_line_memo?: string | null;
922
+ by_journal_entry_line_property?: string | null;
923
+ by_dimension_value_ids?: Array<string> | null;
924
+ by_empty_dimension_id_values?: Array<string> | null;
925
+ id: number;
926
+ dimension: ActivityDimension;
927
+ dimension_value: ActivityDimensionValue;
928
+ accounts?: Array<ActivityTAccountWithoutSubsidiaryMappingOutput>;
929
+ };
930
+ type ActivityDimensionValue = {
931
+ id?: string | null;
932
+ value: string;
933
+ subsidiary_id?: number | null;
934
+ provider_uid?: string | null;
935
+ parent_id?: string | null;
936
+ dimension_id: string;
937
+ is_default: boolean;
938
+ effective_rule_id?: number | null;
939
+ has_children?: boolean;
940
+ };
941
+ type ActivityDimensionValueOverrideSource = 'user' | 'provider';
942
+ /**
943
+ * DueDate represents the due date of a task/activity definition.
944
+ * We will use it to decide the actual due date of a task/activity instance.
945
+ *
946
+ * from_start: if True, the due date is calculated from the start date of the period.
947
+ * days_delta: the number of days/weeks/workdays to shift for start/end date.
948
+ * is_forward: if True, the due date is calculated forward from the start/end date of the period.
949
+ * delta_unit: unit of the delta (Days | Weeks | Workdays), default is Days.
950
+ * is_specific_day: if True, indicates that the due date is a specific calendar day (reserved for future use).
951
+ * should_skip_holidays: when using Workdays, whether to skip country holidays in addition to weekends.
952
+ */
953
+ type ActivityDueDate = {
954
+ from_start: boolean;
955
+ days_delta: number;
956
+ is_forward: boolean;
957
+ delta_unit?: ActivityDeltaUnit;
958
+ is_specific_day?: boolean;
959
+ should_skip_holidays?: boolean;
960
+ };
961
+ type ActivityExchangeRate = {
962
+ from_currency: ActivityCurrency;
963
+ to_currency: ActivityCurrency;
964
+ rate: number;
965
+ };
966
+ type ActivityFailureActionTemplate = {
967
+ action_type?: 'failure_task';
968
+ };
969
+ type ActivityFailureTaskActionData = {
970
+ action_type?: 'failure_task';
971
+ };
972
+ type ActivityGroupTransaction = {
973
+ transaction_id: number;
974
+ journal_entry_id: string;
975
+ elimination_entry_id?: string | null;
976
+ id: number;
977
+ };
978
+ type ActivityIctEliminationDataInput = {
979
+ ict_transaction_id: number;
980
+ eliminations: Array<ActivityIctEliminationEntryInput>;
981
+ };
982
+ type ActivityIctEliminationDataOutput = {
983
+ ict_transaction_id: number;
984
+ eliminations: Array<ActivityIctEliminationEntryOutput>;
985
+ };
986
+ type ActivityIctEliminationEntryInput = {
987
+ journal_entry: ActivityJournalEntryWithLinesWithDimensionValuesInput;
988
+ from_subsidiary_id: number;
989
+ to_subsidiary_id: number;
990
+ };
991
+ type ActivityIctEliminationEntryOutput = {
992
+ journal_entry: ActivityJournalEntryWithLinesWithDimensionValuesOutput;
993
+ from_subsidiary_id: number;
994
+ to_subsidiary_id: number;
995
+ };
996
+ type ActivityJeWriteBackStatus = 'syncing' | 'synced' | 'partial_success' | 'success' | 'failure';
997
+ type ActivityJournalEntryLineWithDimensionValuesInput = {
998
+ id: string;
999
+ account_id: string;
1000
+ journal_entry_id: string;
1001
+ line_num: number;
1002
+ is_debit: boolean;
1003
+ account_provider_id?: string | null;
1004
+ account?: ActivityTAccountWithoutSubsidiaryMappingInput | null;
1005
+ total_amount?: number;
1006
+ primary_currency_amount?: number;
1007
+ secondary_currency_amount?: number;
1008
+ tertiary_currency_amount?: number;
1009
+ subsidiary_id?: number | null;
1010
+ create_time?: string | null;
1011
+ transaction_date?: string | null;
1012
+ memo?: string | null;
1013
+ provider_property?: string | null;
1014
+ is_for_elimination?: boolean;
1015
+ recurring_transaction_id?: string | null;
1016
+ transaction_number?: string | null;
1017
+ po_number?: string | null;
1018
+ sales_order_ref?: string | null;
1019
+ invoice_ref?: string | null;
1020
+ extra_reference?: string | null;
1021
+ assignment_ref?: string | null;
1022
+ dimension_values?: Array<ActivityLineDimensionEffectiveAssignmentInput | ActivityDimensionValue>;
1023
+ };
1024
+ type ActivityJournalEntryLineWithDimensionValuesOutput = {
1025
+ id: string;
1026
+ account_id: string;
1027
+ journal_entry_id: string;
1028
+ line_num: number;
1029
+ is_debit: boolean;
1030
+ account_provider_id?: string | null;
1031
+ account?: ActivityTAccountWithoutSubsidiaryMappingOutput | null;
1032
+ total_amount?: number;
1033
+ primary_currency_amount?: number;
1034
+ secondary_currency_amount?: number;
1035
+ tertiary_currency_amount?: number;
1036
+ subsidiary_id?: number | null;
1037
+ create_time?: string | null;
1038
+ transaction_date?: string | null;
1039
+ memo?: string | null;
1040
+ provider_property?: string | null;
1041
+ is_for_elimination?: boolean;
1042
+ recurring_transaction_id?: string | null;
1043
+ transaction_number?: string | null;
1044
+ po_number?: string | null;
1045
+ sales_order_ref?: string | null;
1046
+ invoice_ref?: string | null;
1047
+ extra_reference?: string | null;
1048
+ assignment_ref?: string | null;
1049
+ dimension_values?: Array<ActivityLineDimensionEffectiveAssignmentOutput | ActivityDimensionValue>;
1050
+ };
1051
+ type ActivityJournalEntrySource = 'Elimination' | 'Journal Entry' | 'Bill' | 'Lease' | 'Invoice' | 'Bill Payment';
1052
+ type ActivityJournalEntryStatus = 'Posted' | 'Draft' | 'Submitted';
1053
+ type ActivityJournalEntryType = 'adjustment' | 'elimination' | 'book_entry' | 'ic_transaction';
1054
+ type ActivityJournalEntryWithLinesWithDimensionValuesInput = {
1055
+ lines?: Array<ActivityJournalEntryLineWithDimensionValuesInput>;
1056
+ created_from: string;
1057
+ currency: ActivityCurrency;
1058
+ memo?: string | null;
1059
+ create_time?: string;
1060
+ transaction_date?: string | null;
1061
+ posting_date?: string | null;
1062
+ is_adjustment?: boolean;
1063
+ transaction_id?: number | null;
1064
+ status?: ActivityJournalEntryStatus;
1065
+ exchange_rates?: Array<ActivityExchangeRate>;
1066
+ id: string;
1067
+ subsidiary_id: number;
1068
+ provider_uid: string;
1069
+ ref_number?: string | null;
1070
+ insert_time?: string;
1071
+ clearing_group_id?: number | null;
1072
+ is_nominal_ledger?: boolean;
1073
+ sub_ledger?: ActivitySubLedger | null;
1074
+ gl_entry_id?: string | null;
1075
+ reconciled?: boolean | null;
1076
+ source_entity?: ActivityJournalEntrySource | null;
1077
+ provider_url?: string | null;
1078
+ posting_period_id?: string | null;
1079
+ syncing_status?: ActivityWriteBackStatusInput | null;
1080
+ group_transaction?: ActivityGroupTransaction | null;
1081
+ reverse_entry_id?: string | null;
1082
+ };
1083
+ type ActivityJournalEntryWithLinesWithDimensionValuesOutput = {
1084
+ lines?: Array<ActivityJournalEntryLineWithDimensionValuesOutput>;
1085
+ created_from: string;
1086
+ currency: ActivityCurrency;
1087
+ memo?: string | null;
1088
+ create_time?: string;
1089
+ transaction_date?: string | null;
1090
+ posting_date?: string | null;
1091
+ is_adjustment?: boolean;
1092
+ transaction_id?: number | null;
1093
+ status?: ActivityJournalEntryStatus;
1094
+ exchange_rates?: Array<ActivityExchangeRate>;
1095
+ id: string;
1096
+ subsidiary_id: number;
1097
+ provider_uid: string;
1098
+ ref_number?: string | null;
1099
+ insert_time?: string;
1100
+ clearing_group_id?: number | null;
1101
+ is_nominal_ledger?: boolean;
1102
+ sub_ledger?: ActivitySubLedger | null;
1103
+ gl_entry_id?: string | null;
1104
+ reconciled?: boolean | null;
1105
+ source_entity?: ActivityJournalEntrySource | null;
1106
+ provider_url?: string | null;
1107
+ posting_period_id?: string | null;
1108
+ syncing_status?: ActivityWriteBackStatusOutput | null;
1109
+ group_transaction?: ActivityGroupTransaction | null;
1110
+ reverse_entry_id?: string | null;
1111
+ };
1112
+ type ActivityLeaseAmortizationOpeningBalanceActionTemplateInput = {
1113
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1114
+ currency: ActivityCurrency;
1115
+ subsidiary_id: number;
1116
+ rou_asset_opening_balance: number;
1117
+ liability_opening_balance: number;
1118
+ primary_start_date: string;
1119
+ lease_id: string;
1120
+ lease_name: string;
1121
+ lease_dimension_value_id: string;
1122
+ vendor_id: string;
1123
+ liability_account_id: string;
1124
+ rou_asset_account_id: string;
1125
+ lease_expense_account_id: string;
1126
+ lease_amortization: Array<ActivityLeaseAmortizationPointInput>;
1127
+ migration_date?: string | null;
1128
+ is_draft?: boolean;
1129
+ };
1130
+ type ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput = {
1131
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1132
+ currency: ActivityCurrency;
1133
+ subsidiary_id: number;
1134
+ rou_asset_opening_balance: number;
1135
+ liability_opening_balance: number;
1136
+ primary_start_date: string;
1137
+ lease_id: string;
1138
+ lease_name: string;
1139
+ lease_dimension_value_id: string;
1140
+ vendor_id: string;
1141
+ liability_account_id: string;
1142
+ rou_asset_account_id: string;
1143
+ lease_expense_account_id: string;
1144
+ lease_amortization: Array<ActivityLeaseAmortizationPointOutput>;
1145
+ migration_date?: string | null;
1146
+ is_draft?: boolean;
1147
+ };
1148
+ type ActivityLeaseAmortizationPointInput = {
1149
+ date: string;
1150
+ payment: ActivityBalanceInput;
1151
+ interest_rate: ActivityBalanceInput;
1152
+ straight_line_payment: ActivityBalanceInput;
1153
+ liability: ActivityBalanceInput;
1154
+ right_of_use_asset: ActivityBalanceInput;
1155
+ term?: ActivityMinimalTerm | null;
1156
+ };
1157
+ type ActivityLeaseAmortizationPointOutput = {
1158
+ date: string;
1159
+ payment: ActivityBalanceOutput;
1160
+ interest_rate: ActivityBalanceOutput;
1161
+ straight_line_payment: ActivityBalanceOutput;
1162
+ liability: ActivityBalanceOutput;
1163
+ right_of_use_asset: ActivityBalanceOutput;
1164
+ term?: ActivityMinimalTerm | null;
1165
+ asset_reduction: ActivityBalanceOutput;
1166
+ };
1167
+ type ActivityLeaseAmortizationScheduleActionTemplateInput = {
1168
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1169
+ currency: ActivityCurrency;
1170
+ subsidiary_id: number;
1171
+ rou_asset_opening_balance: number;
1172
+ liability_opening_balance: number;
1173
+ primary_start_date: string;
1174
+ lease_id: string;
1175
+ lease_name: string;
1176
+ lease_dimension_value_id: string;
1177
+ vendor_id: string;
1178
+ liability_account_id: string;
1179
+ rou_asset_account_id: string;
1180
+ lease_expense_account_id: string;
1181
+ lease_amortization: Array<ActivityLeaseAmortizationPointInput>;
1182
+ migration_date?: string | null;
1183
+ is_draft?: boolean;
1184
+ };
1185
+ type ActivityLeaseAmortizationScheduleActionTemplateOutput = {
1186
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1187
+ currency: ActivityCurrency;
1188
+ subsidiary_id: number;
1189
+ rou_asset_opening_balance: number;
1190
+ liability_opening_balance: number;
1191
+ primary_start_date: string;
1192
+ lease_id: string;
1193
+ lease_name: string;
1194
+ lease_dimension_value_id: string;
1195
+ vendor_id: string;
1196
+ liability_account_id: string;
1197
+ rou_asset_account_id: string;
1198
+ lease_expense_account_id: string;
1199
+ lease_amortization: Array<ActivityLeaseAmortizationPointOutput>;
1200
+ migration_date?: string | null;
1201
+ is_draft?: boolean;
1202
+ };
1203
+ type ActivityLeaseEscalatorFrequency = 'monthly' | 'quarterly' | 'annually';
1204
+ type ActivityLeasePaymentFrequency = 'monthly' | 'quarterly' | 'annually' | 'once';
1205
+ type ActivityLeasePaymentScheduleActionTemplateInput = {
1206
+ action_type?: 'lease_payment';
1207
+ lease_id: string;
1208
+ lease_name: string;
1209
+ currency: ActivityCurrency;
1210
+ lease_dimension_value_id: string;
1211
+ vendor_id: string;
1212
+ billing_account_id: string;
1213
+ payment_terms: Array<ActivityLeasePaymentTerm>;
1214
+ migration_date?: string | null;
1215
+ is_draft?: boolean;
1216
+ };
1217
+ type ActivityLeasePaymentScheduleActionTemplateOutput = {
1218
+ action_type?: 'lease_payment';
1219
+ lease_id: string;
1220
+ lease_name: string;
1221
+ currency: ActivityCurrency;
1222
+ lease_dimension_value_id: string;
1223
+ vendor_id: string;
1224
+ billing_account_id: string;
1225
+ payment_terms: Array<ActivityLeasePaymentTerm>;
1226
+ migration_date?: string | null;
1227
+ is_draft?: boolean;
1228
+ };
1229
+ type ActivityLeasePaymentTerm = {
1230
+ id?: string;
1231
+ name: string;
1232
+ start_date: string;
1233
+ end_date: string;
1234
+ rent_payment: number;
1235
+ payment_frequency?: ActivityLeasePaymentFrequency;
1236
+ escalator_rate?: number;
1237
+ escalator_frequency?: ActivityLeaseEscalatorFrequency | null;
1238
+ primary_term?: boolean;
1239
+ subsidiary_id?: number | null;
1240
+ lease_id: string;
1241
+ };
1242
+ type ActivityLeaseTermReminderActionTemplateInput = {
1243
+ action_type?: 'lease_term_reminder';
1244
+ lease_id: string;
1245
+ lease_name: string;
1246
+ payment_terms: Array<ActivityLeasePaymentTerm>;
1247
+ migration_date?: string | null;
1248
+ is_draft?: boolean;
1249
+ };
1250
+ type ActivityLeaseTermReminderActionTemplateOutput = {
1251
+ action_type?: 'lease_term_reminder';
1252
+ lease_id: string;
1253
+ lease_name: string;
1254
+ payment_terms: Array<ActivityLeasePaymentTerm>;
1255
+ migration_date?: string | null;
1256
+ is_draft?: boolean;
1257
+ };
1258
+ type ActivityLineDimensionEffectiveAssignmentInput = {
1259
+ journal_line_id: string;
1260
+ dimension_id?: string | null;
1261
+ dimension_value_id?: string | null;
1262
+ effective_rule_id?: number | null;
1263
+ dimension_value_override_id?: number | null;
1264
+ dimension_value?: ActivityDimensionValue | null;
1265
+ effective_rule?: ActivityDimensionRuleInput | null;
1266
+ dimension_value_override?: ActivityLineDimensionValueOverride | null;
1267
+ };
1268
+ type ActivityLineDimensionEffectiveAssignmentOutput = {
1269
+ journal_line_id: string;
1270
+ dimension_id?: string | null;
1271
+ dimension_value_id?: string | null;
1272
+ effective_rule_id?: number | null;
1273
+ dimension_value_override_id?: number | null;
1274
+ dimension_value?: ActivityDimensionValue | null;
1275
+ effective_rule?: ActivityDimensionRuleOutput | null;
1276
+ dimension_value_override?: ActivityLineDimensionValueOverride | null;
1277
+ };
1278
+ type ActivityLineDimensionValueOverride = {
1279
+ dimension_id: string;
1280
+ dimension_value_id: string;
1281
+ journal_line_id: string;
1282
+ override_source?: ActivityDimensionValueOverrideSource;
1283
+ id: number;
1284
+ dimension_value?: ActivityDimensionValue | null;
1285
+ };
1286
+ type ActivityLockConsolidationRateActionTemplate = {
1287
+ action_type?: 'lock_consolidation_period';
1288
+ };
1289
+ type ActivityMappedNominalAccount = {
1290
+ id: string;
1291
+ name: string;
1292
+ hierarchy_account_name: string;
1293
+ account_type: ActivityAccountType;
1294
+ account_number?: string | null;
1295
+ };
1296
+ type ActivityMatchResolutionActionTemplate = {
1297
+ action_type?: 'match_resolution';
1298
+ match_id: string;
1299
+ };
1300
+ type ActivityMatchResolutionTaskActionData = {
1301
+ action_type?: 'match_resolution';
1302
+ match_id: string;
1303
+ entity_id?: string | null;
1304
+ entity_type?: ActivityMatchedEntityType | null;
1305
+ trigger_execution_id?: string | null;
1306
+ trigger_id?: string | null;
1307
+ };
1308
+ type ActivityMatchedEntityType = 'bill' | 'bill_payment' | 'invoice' | 'journal_entry' | 'journal_entry_line' | 'bank_line';
1309
+ type ActivityMinimalTerm = {
1310
+ name: string;
1311
+ id: string;
1312
+ };
1313
+ type ActivityPaginationInput = {
1314
+ page?: number | null;
1315
+ per_page?: number | null;
1316
+ include_total?: boolean;
1317
+ position?: ActivityPaginationPositionInput | null;
1318
+ };
1319
+ type ActivityPaginationOutput = {
1320
+ page?: number | null;
1321
+ per_page?: number | null;
1322
+ include_total?: boolean;
1323
+ position?: ActivityPaginationPositionInput | null;
1324
+ pages?: number | null;
1325
+ total?: number | null;
1326
+ };
1327
+ type ActivityPaginationPositionInput = {
1328
+ start: number;
1329
+ end: number;
1330
+ };
1331
+ type ActivityPeriod = 'Annual' | 'Quarterly' | 'Monthly';
1332
+ type ActivityPeriodData = {
1333
+ id: string;
1334
+ name: string;
1335
+ start_date: string;
1336
+ frequency: ActivityPeriod;
1337
+ };
1338
+ type ActivityPeriodFilter = 'ALL_DATES' | 'TTM' | 'THIS_WEEK' | 'THIS_MONTH' | 'THIS_QUARTER' | 'THIS_YEAR' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_QUARTER' | 'LAST_YEAR' | 'LAST_30_DAYS' | 'LAST_60_DAYS' | 'LAST_90_DAYS' | 'NEXT_30_DAYS' | 'NEXT_60_DAYS' | 'NEXT_90_DAYS' | 'CUSTOM';
1339
+ /**
1340
+ * API representation of PeriodInstanceProgressBreakdown.
1341
+ *
1342
+ * Uses a plain 'display_id' field instead of a computed property to avoid
1343
+ * dependency on TenantContext during serialization.
1344
+ */
1345
+ type ActivityPeriodInstanceProgressBreakdownApi = {
1346
+ id: string;
1347
+ period: ActivityPeriod;
1348
+ start_date: string;
1349
+ end_date: string;
1350
+ name: string;
1351
+ display_id: string;
1352
+ progress: ActivityTasksProgress;
1353
+ activities?: Array<ActivityActivitySubsidiaryProgress>;
1354
+ };
1355
+ type ActivityPostBillDataInput = {
1356
+ bill_id: string;
1357
+ bill: ActivityBillUpdateBase;
1358
+ bill_items?: Array<ActivityBillItemCreate> | null;
1359
+ dimension_value_ids?: Array<string>;
1360
+ };
1361
+ type ActivityPostBillDataOutput = {
1362
+ bill_id: string;
1363
+ bill: ActivityBillUpdateBase;
1364
+ bill_items?: Array<ActivityBillItemCreate> | null;
1365
+ dimension_value_ids?: Array<string>;
1366
+ };
1367
+ type ActivityPostBillTaskActionDataInput = {
1368
+ action_type?: 'post_bill';
1369
+ bill_data: ActivityPostBillDataInput;
1370
+ };
1371
+ type ActivityPostBillTaskActionDataOutput = {
1372
+ action_type?: 'post_bill';
1373
+ bill_data: ActivityPostBillDataOutput;
1374
+ };
1375
+ type ActivityPostIctActionTemplate = {
1376
+ action_type?: 'post_ict';
1377
+ ict_id: number;
1378
+ };
1379
+ type ActivityPostIctTaskActionData = {
1380
+ action_type?: 'post_ict';
1381
+ ict_id: number;
1382
+ };
1383
+ type ActivityPostJournalEntryTaskActionDataInput = {
1384
+ action_type?: 'post_journal_entry';
1385
+ journal_entry: ActivityJournalEntryWithLinesWithDimensionValuesInput;
1386
+ };
1387
+ type ActivityPostJournalEntryTaskActionDataOutput = {
1388
+ action_type?: 'post_journal_entry';
1389
+ journal_entry: ActivityJournalEntryWithLinesWithDimensionValuesOutput;
1390
+ };
1391
+ type ActivityProviderOperationErrorType = 'Connection Error' | 'Authentication Error' | 'Data Operation Error' | 'Server Error' | 'Not Ready For Sync';
1392
+ type ActivityReconciliationDefinitionData = {
1393
+ type: ActivityReconciliationType;
1394
+ task_definition_id: string;
1395
+ side_a_entity_type: ActivityReconciliationEntityType;
1396
+ side_a_entity_id: string;
1397
+ side_b_entity_type: ActivityReconciliationEntityType;
1398
+ side_b_entity_id?: string | null;
1399
+ side_a_source: ActivityReconciliationSource;
1400
+ side_b_source: ActivityReconciliationSource;
1401
+ };
1402
+ type ActivityReconciliationEntityType = 'account' | 'bank_account' | 'external_balance_capture';
1403
+ type ActivityReconciliationInstanceDataInput = {
1404
+ reconciliation_definition_id: string;
1405
+ task_instance_id: string;
1406
+ start_date: string;
1407
+ end_date: string;
1408
+ currency?: ActivityCurrency | null;
1409
+ side_a_value?: number | string | null;
1410
+ side_b_value?: number | string | null;
1411
+ reconciling_items_balance?: number | string | null;
1412
+ variance?: number | string | null;
1413
+ variance_percentage?: number | string | null;
1414
+ has_post_signoff_changes?: boolean;
1415
+ event_timestamp?: string | null;
1416
+ };
1417
+ type ActivityReconciliationInstanceDataOutput = {
1418
+ reconciliation_definition_id: string;
1419
+ task_instance_id: string;
1420
+ start_date: string;
1421
+ end_date: string;
1422
+ currency?: ActivityCurrency | null;
1423
+ side_a_value?: string | null;
1424
+ side_b_value?: string | null;
1425
+ reconciling_items_balance?: string | null;
1426
+ variance?: string | null;
1427
+ variance_percentage?: string | null;
1428
+ has_post_signoff_changes?: boolean;
1429
+ event_timestamp?: string | null;
1430
+ };
1431
+ type ActivityReconciliationSource = 'gl' | 'bank' | 'external';
1432
+ type ActivityReconciliationStatus = 'PENDING' | 'IN_PROGRESS' | 'DONE' | 'FAILED';
1433
+ type ActivityReconciliationSubmitActionTemplate = {
1434
+ action_type?: 'reconciliation_submit';
1435
+ reconciliation_definition_id: string;
1436
+ };
1437
+ type ActivityReconciliationSubmitTaskActionDataInput = {
1438
+ action_type?: 'reconciliation_submit';
1439
+ reconciliation_definition_id: string;
1440
+ reconciliation_definition: ActivityReconciliationDefinitionData;
1441
+ reconciliation_instance_id?: string | null;
1442
+ reconciliation_instance?: ActivityReconciliationInstanceDataInput | null;
1443
+ };
1444
+ type ActivityReconciliationSubmitTaskActionDataOutput = {
1445
+ action_type?: 'reconciliation_submit';
1446
+ reconciliation_definition_id: string;
1447
+ reconciliation_definition: ActivityReconciliationDefinitionData;
1448
+ reconciliation_instance_id?: string | null;
1449
+ reconciliation_instance?: ActivityReconciliationInstanceDataOutput | null;
1450
+ };
1451
+ type ActivityReconciliationType = 'bank_reconciliation' | 'account_reconciliation';
1452
+ type ActivitySlimTaskAction = {
1453
+ created_at?: string | null;
1454
+ last_modified_at?: string | null;
1455
+ id?: string;
1456
+ task_instance_id: string;
1457
+ status: ActivityTaskActionStatus;
1458
+ execution_start_time?: string | null;
1459
+ };
1460
+ type ActivitySlimTaskDefinitionWithInstances = {
1461
+ name: string;
1462
+ due_date: ActivityTaskDueDate;
1463
+ preparer_due_date?: ActivityDueDate | null;
1464
+ description?: string | null;
1465
+ preparer_id?: string | null;
1466
+ assignee_id?: string | null;
1467
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1468
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1469
+ end_date?: string | null;
1470
+ task_type?: ActivityTaskType | null;
1471
+ created_at?: string | null;
1472
+ last_modified_at?: string | null;
1473
+ is_deleted?: boolean;
1474
+ activity_definition_id: string;
1475
+ start_date: string;
1476
+ subsidiary_ids: Array<number>;
1477
+ activity_instance_id?: string | null;
1478
+ recurring: boolean;
1479
+ id?: string;
1480
+ creator_user_id?: string | null;
1481
+ is_manual_task?: boolean;
1482
+ entities?: Array<ActivityTaskEntityMapping>;
1483
+ action_template?: (({
1484
+ action_type?: 'create_journal_entry';
1485
+ } & ActivityCreateJournalEntryActionTemplateOutput) | ({
1486
+ action_type?: 'create_ict_elimination_entries';
1487
+ } & ActivityCreateIctEliminationActionTemplateOutput) | ({
1488
+ action_type?: 'post_ict';
1489
+ } & ActivityPostIctActionTemplate) | ({
1490
+ action_type?: 'test_action';
1491
+ } & ActivityTestActionTemplate) | ({
1492
+ action_type?: 'test_schedule_action';
1493
+ } & ActivityTestScheduleActionTemplate) | ({
1494
+ action_type?: 'lease_payment';
1495
+ } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1496
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1497
+ } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1498
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1499
+ } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1500
+ action_type?: 'lease_term_reminder';
1501
+ } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1502
+ action_type?: 'create_journal_entry_schedule';
1503
+ } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1504
+ action_type?: 'create_journal_entries';
1505
+ } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
1506
+ action_type?: 'failure_task';
1507
+ } & ActivityFailureActionTemplate) | ({
1508
+ action_type?: 'lock_consolidation_period';
1509
+ } & ActivityLockConsolidationRateActionTemplate) | ({
1510
+ action_type?: 'create_journal_entries_bulk';
1511
+ } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
1512
+ action_type?: 'match_resolution';
1513
+ } & ActivityMatchResolutionActionTemplate) | ({
1514
+ action_type?: 'reconciliation_submit';
1515
+ } & ActivityReconciliationSubmitActionTemplate)) | null;
1516
+ reconciliation_definition_params?: ({
1517
+ reconciliation_type?: 'account_reconciliation';
1518
+ } & ActivityAccountReconciliationParams) | null;
1519
+ trigger_id?: string | null;
1520
+ workflow_execution_id?: string | null;
1521
+ creator_task_id?: string | null;
1522
+ activity_definition: ActivityActivityDefinitionCreateWithType;
1523
+ action_type?: string | null;
1524
+ task_instances?: Array<ActivityBaseTaskInstanceWithAction>;
1525
+ creator: ActivityTaskCreator | null;
1526
+ };
1527
+ type ActivitySlimTaskInstanceWithAction = {
1528
+ last_manually_updated?: string | null;
1529
+ created_at?: string | null;
1530
+ last_modified_at?: string | null;
1531
+ id: string;
1532
+ name: string;
1533
+ due_date: string;
1534
+ preparer_due_date: string;
1535
+ status: ActivityTaskStatus;
1536
+ description?: string | null;
1537
+ task_definition_id: string;
1538
+ activity_instance_id: string;
1539
+ subsidiary_id: number;
1540
+ is_deleted?: boolean;
1541
+ preparer_id?: string | null;
1542
+ assignee_id?: string | null;
1543
+ reconciled?: boolean | null;
1544
+ creator?: ActivityTaskCreator | null;
1545
+ decline_reason?: string | null;
1546
+ trigger_execution_id?: string | null;
1547
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1548
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1549
+ is_currently_blocked?: boolean | null;
1550
+ is_blocking_manually_set?: boolean;
1551
+ task_type?: ActivityTaskType | null;
1552
+ attachments_count?: number;
1553
+ task_action?: ActivitySlimTaskAction | null;
1554
+ task_action_type?: string | null;
1555
+ is_manual_task?: boolean | null;
1556
+ activity_name?: string | null;
1557
+ period_display_id?: string | null;
1558
+ activity_definition_id?: string | null;
1559
+ };
1560
+ type ActivitySlimTaskInstanceWithActionAndEntities = {
1561
+ last_manually_updated?: string | null;
1562
+ created_at?: string | null;
1563
+ last_modified_at?: string | null;
1564
+ id: string;
1565
+ name: string;
1566
+ due_date: string;
1567
+ preparer_due_date: string;
1568
+ status: ActivityTaskStatus;
1569
+ description?: string | null;
1570
+ task_definition_id: string;
1571
+ activity_instance_id: string;
1572
+ subsidiary_id: number;
1573
+ is_deleted?: boolean;
1574
+ preparer_id?: string | null;
1575
+ assignee_id?: string | null;
1576
+ reconciled?: boolean | null;
1577
+ creator?: ActivityTaskCreator | null;
1578
+ decline_reason?: string | null;
1579
+ trigger_execution_id?: string | null;
1580
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1581
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1582
+ is_currently_blocked?: boolean | null;
1583
+ is_blocking_manually_set?: boolean;
1584
+ task_type?: ActivityTaskType | null;
1585
+ attachments_count?: number;
1586
+ task_action?: ActivitySlimTaskAction | null;
1587
+ task_action_type?: string | null;
1588
+ is_manual_task?: boolean | null;
1589
+ activity_name?: string | null;
1590
+ period_display_id?: string | null;
1591
+ activity_definition_id?: string | null;
1592
+ task_definition_entities?: Array<ActivityTaskEntityMapping> | null;
1593
+ };
1594
+ type ActivitySortableFieldsTask = 'due_date' | 'name' | 'subsidiary_id' | 'status' | 'preparer_id' | 'assignee_id' | 'activity_name' | 'closing_period';
1595
+ type ActivitySortingOrder = 'asc' | 'desc';
1596
+ type ActivitySubLedger = 'lease' | 'prepaid_expense';
1597
+ /**
1598
+ * Progress for a subsidiary within an activity.
1599
+ */
1600
+ type ActivitySubsidiaryProgress = {
1601
+ subsidiary_id: number;
1602
+ progress: ActivityTasksProgress;
1603
+ };
1604
+ type ActivityTAccountWithoutSubsidiaryMappingInput = {
1605
+ id: string;
1606
+ name: string;
1607
+ report_category?: ActivityAccountReportCategory | null;
1608
+ accounting_class: ActivityAccountingClass;
1609
+ account_type: ActivityAccountType;
1610
+ account_rate_type?: ActivityConsolidationExchangeRateType | null;
1611
+ account_number?: string | null;
1612
+ parent_account_id?: string | null;
1613
+ active?: boolean;
1614
+ summary?: boolean;
1615
+ read_only?: boolean;
1616
+ is_manually_created?: boolean;
1617
+ provider_id: string;
1618
+ subsidiary_id: number;
1619
+ currency?: ActivityCurrency;
1620
+ sourced_account_id?: string | null;
1621
+ account_balance?: ActivityBalanceInput;
1622
+ primary_balance?: ActivityBalanceInput;
1623
+ secondary_balance?: ActivityBalanceInput;
1624
+ cta_balance?: ActivityBalanceInput;
1625
+ credit_account_balance?: ActivityBalanceInput;
1626
+ debit_account_balance?: ActivityBalanceInput;
1627
+ credit_primary_balance?: ActivityBalanceInput;
1628
+ debit_primary_balance?: ActivityBalanceInput;
1629
+ credit_secondary_balance?: ActivityBalanceInput;
1630
+ debit_secondary_balance?: ActivityBalanceInput;
1631
+ credit_cta_balance?: ActivityBalanceInput;
1632
+ debit_cta_balance?: ActivityBalanceInput;
1633
+ tertiary_debit?: ActivityBalanceInput | null;
1634
+ tertiary_credit?: ActivityBalanceInput | null;
1635
+ create_time?: string;
1636
+ last_update_time?: string;
1637
+ description?: string | null;
1638
+ meta?: {
1639
+ [key: string]: unknown;
1640
+ } | null;
1641
+ nominal_account?: ActivityMappedNominalAccount | null;
1642
+ };
1643
+ type ActivityTAccountWithoutSubsidiaryMappingOutput = {
1644
+ id: string;
1645
+ name: string;
1646
+ report_category?: ActivityAccountReportCategory | null;
1647
+ accounting_class: ActivityAccountingClass;
1648
+ account_type: ActivityAccountType;
1649
+ account_rate_type?: ActivityConsolidationExchangeRateType | null;
1650
+ account_number?: string | null;
1651
+ parent_account_id?: string | null;
1652
+ active?: boolean;
1653
+ summary?: boolean;
1654
+ read_only?: boolean;
1655
+ is_manually_created?: boolean;
1656
+ provider_id: string;
1657
+ subsidiary_id: number;
1658
+ currency?: ActivityCurrency;
1659
+ sourced_account_id?: string | null;
1660
+ account_balance?: ActivityBalanceOutput;
1661
+ primary_balance?: ActivityBalanceOutput;
1662
+ secondary_balance?: ActivityBalanceOutput;
1663
+ cta_balance?: ActivityBalanceOutput;
1664
+ credit_account_balance?: ActivityBalanceOutput;
1665
+ debit_account_balance?: ActivityBalanceOutput;
1666
+ credit_primary_balance?: ActivityBalanceOutput;
1667
+ debit_primary_balance?: ActivityBalanceOutput;
1668
+ credit_secondary_balance?: ActivityBalanceOutput;
1669
+ debit_secondary_balance?: ActivityBalanceOutput;
1670
+ credit_cta_balance?: ActivityBalanceOutput;
1671
+ debit_cta_balance?: ActivityBalanceOutput;
1672
+ tertiary_debit?: ActivityBalanceOutput | null;
1673
+ tertiary_credit?: ActivityBalanceOutput | null;
1674
+ create_time?: string;
1675
+ last_update_time?: string;
1676
+ description?: string | null;
1677
+ meta?: {
1678
+ [key: string]: unknown;
1679
+ } | null;
1680
+ nominal_account?: ActivityMappedNominalAccount | null;
1681
+ };
1682
+ type ActivityTaskActionInput = {
1683
+ created_at?: string | null;
1684
+ last_modified_at?: string | null;
1685
+ id?: string;
1686
+ task_instance_id: string;
1687
+ status: ActivityTaskActionStatus;
1688
+ execution_start_time?: string | null;
1689
+ action_data: ({
1690
+ action_type?: 'create_journal_entry';
1691
+ } & ActivityCreateJournalEntryTaskActionDataInput) | ({
1692
+ action_type?: 'create_ict_elimination_entries';
1693
+ } & ActivityCreateIctEliminationTaskActionDataInput) | ({
1694
+ action_type?: 'test_action';
1695
+ } & ActivityTestActionData) | ({
1696
+ action_type?: 'create_bill';
1697
+ } & ActivityCreateBillTaskActionDataInput) | ({
1698
+ action_type?: 'post_bill';
1699
+ } & ActivityPostBillTaskActionDataInput) | ({
1700
+ action_type?: 'post_journal_entry';
1701
+ } & ActivityPostJournalEntryTaskActionDataInput) | ({
1702
+ action_type?: 'post_ict';
1703
+ } & ActivityPostIctTaskActionData) | ({
1704
+ action_type?: 'create_journal_entry_schedule';
1705
+ } & ActivityCreateJournalEntryTaskScheduleActionDataInput) | ({
1706
+ action_type?: 'failure_task';
1707
+ } & ActivityFailureTaskActionData) | ({
1708
+ action_type?: 'lock_consolidation_period';
1709
+ } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1710
+ action_type?: 'create_journal_entries_bulk';
1711
+ } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1712
+ action_type?: 'match_resolution';
1713
+ } & ActivityMatchResolutionTaskActionData) | ({
1714
+ action_type?: 'reconciliation_submit';
1715
+ } & ActivityReconciliationSubmitTaskActionDataInput);
1716
+ original_action_data?: (({
1717
+ action_type?: 'create_journal_entry';
1718
+ } & ActivityCreateJournalEntryTaskActionDataInput) | ({
1719
+ action_type?: 'create_ict_elimination_entries';
1720
+ } & ActivityCreateIctEliminationTaskActionDataInput) | ({
1721
+ action_type?: 'test_action';
1722
+ } & ActivityTestActionData) | ({
1723
+ action_type?: 'create_bill';
1724
+ } & ActivityCreateBillTaskActionDataInput) | ({
1725
+ action_type?: 'post_bill';
1726
+ } & ActivityPostBillTaskActionDataInput) | ({
1727
+ action_type?: 'post_journal_entry';
1728
+ } & ActivityPostJournalEntryTaskActionDataInput) | ({
1729
+ action_type?: 'post_ict';
1730
+ } & ActivityPostIctTaskActionData) | ({
1731
+ action_type?: 'create_journal_entry_schedule';
1732
+ } & ActivityCreateJournalEntryTaskScheduleActionDataInput) | ({
1733
+ action_type?: 'failure_task';
1734
+ } & ActivityFailureTaskActionData) | ({
1735
+ action_type?: 'lock_consolidation_period';
1736
+ } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1737
+ action_type?: 'create_journal_entries_bulk';
1738
+ } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1739
+ action_type?: 'match_resolution';
1740
+ } & ActivityMatchResolutionTaskActionData) | ({
1741
+ action_type?: 'reconciliation_submit';
1742
+ } & ActivityReconciliationSubmitTaskActionDataInput)) | null;
1743
+ execution_errors?: Array<ActivityTaskActionExecutionError> | null;
1744
+ };
1745
+ type ActivityTaskActionOutput = {
1746
+ created_at?: string | null;
1747
+ last_modified_at?: string | null;
1748
+ id?: string;
1749
+ task_instance_id: string;
1750
+ status: ActivityTaskActionStatus;
1751
+ execution_start_time?: string | null;
1752
+ action_data: ({
1753
+ action_type?: 'create_journal_entry';
1754
+ } & ActivityCreateJournalEntryTaskActionDataOutput) | ({
1755
+ action_type?: 'create_ict_elimination_entries';
1756
+ } & ActivityCreateIctEliminationTaskActionDataOutput) | ({
1757
+ action_type?: 'test_action';
1758
+ } & ActivityTestActionData) | ({
1759
+ action_type?: 'create_bill';
1760
+ } & ActivityCreateBillTaskActionDataOutput) | ({
1761
+ action_type?: 'post_bill';
1762
+ } & ActivityPostBillTaskActionDataOutput) | ({
1763
+ action_type?: 'post_journal_entry';
1764
+ } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1765
+ action_type?: 'post_ict';
1766
+ } & ActivityPostIctTaskActionData) | ({
1767
+ action_type?: 'create_journal_entry_schedule';
1768
+ } & ActivityCreateJournalEntryTaskScheduleActionDataOutput) | ({
1769
+ action_type?: 'failure_task';
1770
+ } & ActivityFailureTaskActionData) | ({
1771
+ action_type?: 'lock_consolidation_period';
1772
+ } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1773
+ action_type?: 'create_journal_entries_bulk';
1774
+ } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1775
+ action_type?: 'match_resolution';
1776
+ } & ActivityMatchResolutionTaskActionData) | ({
1777
+ action_type?: 'reconciliation_submit';
1778
+ } & ActivityReconciliationSubmitTaskActionDataOutput);
1779
+ original_action_data?: (({
1780
+ action_type?: 'create_journal_entry';
1781
+ } & ActivityCreateJournalEntryTaskActionDataOutput) | ({
1782
+ action_type?: 'create_ict_elimination_entries';
1783
+ } & ActivityCreateIctEliminationTaskActionDataOutput) | ({
1784
+ action_type?: 'test_action';
1785
+ } & ActivityTestActionData) | ({
1786
+ action_type?: 'create_bill';
1787
+ } & ActivityCreateBillTaskActionDataOutput) | ({
1788
+ action_type?: 'post_bill';
1789
+ } & ActivityPostBillTaskActionDataOutput) | ({
1790
+ action_type?: 'post_journal_entry';
1791
+ } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1792
+ action_type?: 'post_ict';
1793
+ } & ActivityPostIctTaskActionData) | ({
1794
+ action_type?: 'create_journal_entry_schedule';
1795
+ } & ActivityCreateJournalEntryTaskScheduleActionDataOutput) | ({
1796
+ action_type?: 'failure_task';
1797
+ } & ActivityFailureTaskActionData) | ({
1798
+ action_type?: 'lock_consolidation_period';
1799
+ } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1800
+ action_type?: 'create_journal_entries_bulk';
1801
+ } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1802
+ action_type?: 'match_resolution';
1803
+ } & ActivityMatchResolutionTaskActionData) | ({
1804
+ action_type?: 'reconciliation_submit';
1805
+ } & ActivityReconciliationSubmitTaskActionDataOutput)) | null;
1806
+ execution_errors?: Array<ActivityTaskActionExecutionError> | null;
1807
+ };
1808
+ type ActivityTaskActionExecutionError = {
1809
+ error_type: ActivityTaskActionExecutionErrorType;
1810
+ error_message: string;
1811
+ error_summary?: string | null;
1812
+ error_time?: string;
1813
+ required_action?: string | null;
1814
+ subsidiary_id?: number | null;
1815
+ };
1816
+ type ActivityTaskActionExecutionErrorType = 'Server Error' | 'Provider Validation Error' | 'Provider Connection Error' | 'Provider Authentication Error';
1817
+ type ActivityTaskActionStatus = 'DONE' | 'PENDING' | 'CANCELLED' | 'FAILED' | 'IN_PROGRESS' | 'RESETTING';
1818
+ /**
1819
+ * Represents a blocking relationship for a definition or instance.
1820
+ */
1821
+ type ActivityTaskBlocking = {
1822
+ id: string;
1823
+ scope: ActivityBlockingScope;
1824
+ };
1825
+ type ActivityTaskCreator = {
1826
+ type?: ActivityTaskCreatorType | null;
1827
+ entity_type?: ActivityTaskEntityType | null;
1828
+ id?: string | null;
1829
+ };
1830
+ type ActivityTaskCreatorType = 'user' | 'trigger' | 'workflow_execution' | 'task' | 'entity';
1831
+ type ActivityTaskDefinition = {
1832
+ name: string;
1833
+ due_date: ActivityTaskDueDate;
1834
+ preparer_due_date?: ActivityDueDate | null;
1835
+ description?: string | null;
1836
+ preparer_id?: string | null;
1837
+ assignee_id?: string | null;
1838
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1839
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1840
+ end_date?: string | null;
1841
+ task_type?: ActivityTaskType | null;
1842
+ created_at?: string | null;
1843
+ last_modified_at?: string | null;
1844
+ is_deleted?: boolean;
1845
+ activity_definition_id: string;
1846
+ start_date: string;
1847
+ subsidiary_ids: Array<number>;
1848
+ activity_instance_id?: string | null;
1849
+ recurring: boolean;
1850
+ id?: string;
1851
+ creator_user_id?: string | null;
1852
+ is_manual_task?: boolean;
1853
+ entities?: Array<ActivityTaskEntityMapping>;
1854
+ action_template?: (({
1855
+ action_type?: 'create_journal_entry';
1856
+ } & ActivityCreateJournalEntryActionTemplateOutput) | ({
1857
+ action_type?: 'create_ict_elimination_entries';
1858
+ } & ActivityCreateIctEliminationActionTemplateOutput) | ({
1859
+ action_type?: 'post_ict';
1860
+ } & ActivityPostIctActionTemplate) | ({
1861
+ action_type?: 'test_action';
1862
+ } & ActivityTestActionTemplate) | ({
1863
+ action_type?: 'test_schedule_action';
1864
+ } & ActivityTestScheduleActionTemplate) | ({
1865
+ action_type?: 'lease_payment';
1866
+ } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1867
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1868
+ } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1869
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1870
+ } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1871
+ action_type?: 'lease_term_reminder';
1872
+ } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1873
+ action_type?: 'create_journal_entry_schedule';
1874
+ } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1875
+ action_type?: 'create_journal_entries';
1876
+ } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
1877
+ action_type?: 'failure_task';
1878
+ } & ActivityFailureActionTemplate) | ({
1879
+ action_type?: 'lock_consolidation_period';
1880
+ } & ActivityLockConsolidationRateActionTemplate) | ({
1881
+ action_type?: 'create_journal_entries_bulk';
1882
+ } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
1883
+ action_type?: 'match_resolution';
1884
+ } & ActivityMatchResolutionActionTemplate) | ({
1885
+ action_type?: 'reconciliation_submit';
1886
+ } & ActivityReconciliationSubmitActionTemplate)) | null;
1887
+ reconciliation_definition_params?: ({
1888
+ reconciliation_type?: 'account_reconciliation';
1889
+ } & ActivityAccountReconciliationParams) | null;
1890
+ trigger_id?: string | null;
1891
+ workflow_execution_id?: string | null;
1892
+ creator_task_id?: string | null;
1893
+ activity_definition: ActivityActivityDefinitionCreateWithType;
1894
+ action_type?: string | null;
1895
+ creator: ActivityTaskCreator | null;
1896
+ };
1897
+ type ActivityTaskDefinitionUpdate = {
1898
+ name: string;
1899
+ due_date: ActivityTaskDueDate;
1900
+ preparer_due_date?: ActivityDueDate | null;
1901
+ description?: string | null;
1902
+ preparer_id?: string | null;
1903
+ assignee_id?: string | null;
1904
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1905
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1906
+ end_date?: string | null;
1907
+ task_type?: ActivityTaskType | null;
1908
+ created_at?: string | null;
1909
+ last_modified_at?: string | null;
1910
+ is_deleted?: boolean;
1911
+ activity_definition_id: string;
1912
+ start_date: string;
1913
+ subsidiary_ids: Array<number>;
1914
+ activity_instance_id?: string | null;
1915
+ recurring: boolean;
1916
+ };
1917
+ type ActivityTaskDefinitionWithActionCreateApi = {
1918
+ name: string;
1919
+ due_date: ActivityTaskDueDate;
1920
+ preparer_due_date?: ActivityDueDate | null;
1921
+ description?: string | null;
1922
+ preparer_id?: string | null;
1923
+ assignee_id?: string | null;
1924
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
1925
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1926
+ end_date?: string | null;
1927
+ task_type?: ActivityTaskType | null;
1928
+ created_at?: string | null;
1929
+ last_modified_at?: string | null;
1930
+ is_deleted?: boolean;
1931
+ activity_definition_id: string;
1932
+ start_date: string;
1933
+ subsidiary_ids: Array<number>;
1934
+ activity_instance_id?: string | null;
1935
+ recurring: boolean;
1936
+ id?: string;
1937
+ creator_user_id?: string | null;
1938
+ is_manual_task?: boolean;
1939
+ entities?: Array<ActivityTaskEntityMappingCreate>;
1940
+ action_template?: (({
1941
+ action_type?: 'create_journal_entry';
1942
+ } & ActivityCreateJournalEntryActionTemplateInput) | ({
1943
+ action_type?: 'create_ict_elimination_entries';
1944
+ } & ActivityCreateIctEliminationActionTemplateInput) | ({
1945
+ action_type?: 'post_ict';
1946
+ } & ActivityPostIctActionTemplate) | ({
1947
+ action_type?: 'test_action';
1948
+ } & ActivityTestActionTemplate) | ({
1949
+ action_type?: 'test_schedule_action';
1950
+ } & ActivityTestScheduleActionTemplate) | ({
1951
+ action_type?: 'lease_payment';
1952
+ } & ActivityLeasePaymentScheduleActionTemplateInput) | ({
1953
+ action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1954
+ } & ActivityLeaseAmortizationScheduleActionTemplateInput) | ({
1955
+ action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1956
+ } & ActivityLeaseAmortizationOpeningBalanceActionTemplateInput) | ({
1957
+ action_type?: 'lease_term_reminder';
1958
+ } & ActivityLeaseTermReminderActionTemplateInput) | ({
1959
+ action_type?: 'create_journal_entry_schedule';
1960
+ } & ActivityCreateJournalEntryScheduleActionTemplateInput) | ({
1961
+ action_type?: 'create_journal_entries';
1962
+ } & ActivityCreateJournalEntriesActionTemplateInput) | ({
1963
+ action_type?: 'failure_task';
1964
+ } & ActivityFailureActionTemplate) | ({
1965
+ action_type?: 'lock_consolidation_period';
1966
+ } & ActivityLockConsolidationRateActionTemplate) | ({
1967
+ action_type?: 'create_journal_entries_bulk';
1968
+ } & ActivityCreateJournalEntriesBulkActionTemplateInput) | ({
1969
+ action_type?: 'match_resolution';
1970
+ } & ActivityMatchResolutionActionTemplate) | ({
1971
+ action_type?: 'reconciliation_submit';
1972
+ } & ActivityReconciliationSubmitActionTemplate)) | null;
1973
+ reconciliation_definition_params?: ({
1974
+ reconciliation_type?: 'account_reconciliation';
1975
+ } & ActivityAccountReconciliationParams) | null;
1976
+ };
1977
+ /**
1978
+ * Task-specific DueDate that carries an optional preparer/reviewer offset.
1979
+ *
1980
+ * Stored in task_definition.due_date JSONB. Not added to the shared libcommon
1981
+ * DueDate. No min/max on offset: range is enforced in the FE so the BE can stay
1982
+ * reusable if product changes the bounds (0 means preparer == reviewer).
1983
+ */
1984
+ type ActivityTaskDueDate = {
1985
+ from_start: boolean;
1986
+ days_delta: number;
1987
+ is_forward: boolean;
1988
+ delta_unit?: ActivityDeltaUnit;
1989
+ is_specific_day?: boolean;
1990
+ should_skip_holidays?: boolean;
1991
+ offset?: number | null;
1992
+ };
1993
+ /**
1994
+ * Model representing an entity mapping for a task definition.
1995
+ */
1996
+ type ActivityTaskEntityMapping = {
1997
+ entity_id: string;
1998
+ entity_type: ActivityTaskEntityType;
1999
+ task_definition_id: string;
2000
+ };
2001
+ /**
2002
+ * Model representing an entity mapping for a task definition.
2003
+ */
2004
+ type ActivityTaskEntityMappingCreate = {
2005
+ entity_id: string;
2006
+ entity_type: ActivityTaskEntityType;
2007
+ };
2008
+ type ActivityTaskEntityType = 'lease' | 'transaction' | 'clearing_group' | 'journal_entry' | 'invoice' | 'workflow_output' | 'attachment' | 'match' | 'reconciliation';
2009
+ type ActivityTaskInstancePaginationOutput = {
2010
+ results?: Array<ActivityTaskInstanceWithActivity | ActivitySlimTaskInstanceWithActionAndEntities | ActivitySlimTaskInstanceWithAction>;
2011
+ pagination?: ActivityPaginationOutput | null;
2012
+ };
2013
+ type ActivityTaskInstanceSearch = {
2014
+ q?: string | null;
2015
+ };
2016
+ type ActivityTaskInstanceUpdate = {
2017
+ name?: string | null;
2018
+ description?: string | null;
2019
+ due_date?: string | null;
2020
+ assignee_id?: string | null;
2021
+ preparer_id?: string | null;
2022
+ reviewer_id?: string | null;
2023
+ status?: ActivityTaskStatus | null;
2024
+ preparer_due_date?: string | null;
2025
+ trigger_execution_id?: string | null;
2026
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
2027
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2028
+ };
2029
+ /**
2030
+ * Clears the task action from a task instance.
2031
+ *
2032
+ * Send {"task_action": null} in the PUT body to hard-delete the existing
2033
+ * StoredTaskAction row. Sending {} (no key) maps to plain TaskInstanceUpdate
2034
+ * and leaves any existing task action untouched.
2035
+ */
2036
+ type ActivityTaskInstanceUpdateClearAction = {
2037
+ name?: string | null;
2038
+ description?: string | null;
2039
+ due_date?: string | null;
2040
+ assignee_id?: string | null;
2041
+ preparer_id?: string | null;
2042
+ reviewer_id?: string | null;
2043
+ status?: ActivityTaskStatus | null;
2044
+ preparer_due_date?: string | null;
2045
+ trigger_execution_id?: string | null;
2046
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
2047
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2048
+ task_action: null;
2049
+ };
2050
+ type ActivityTaskInstanceUpdateWithAction = {
2051
+ name?: string | null;
2052
+ description?: string | null;
2053
+ due_date?: string | null;
2054
+ assignee_id?: string | null;
2055
+ preparer_id?: string | null;
2056
+ reviewer_id?: string | null;
2057
+ status?: ActivityTaskStatus | null;
2058
+ preparer_due_date?: string | null;
2059
+ trigger_execution_id?: string | null;
2060
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
2061
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2062
+ task_action: ActivityTaskActionInput;
2063
+ };
2064
+ type ActivityTaskInstanceWithAction = {
2065
+ last_manually_updated?: string | null;
2066
+ created_at?: string | null;
2067
+ last_modified_at?: string | null;
2068
+ id: string;
2069
+ name: string;
2070
+ due_date: string;
2071
+ preparer_due_date: string;
2072
+ status: ActivityTaskStatus;
2073
+ description?: string | null;
2074
+ task_definition_id: string;
2075
+ activity_instance_id: string;
2076
+ subsidiary_id: number;
2077
+ is_deleted?: boolean;
2078
+ preparer_id?: string | null;
2079
+ assignee_id?: string | null;
2080
+ reconciled?: boolean | null;
2081
+ creator?: ActivityTaskCreator | null;
2082
+ decline_reason?: string | null;
2083
+ trigger_execution_id?: string | null;
2084
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
2085
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2086
+ is_currently_blocked?: boolean | null;
2087
+ is_blocking_manually_set?: boolean;
2088
+ task_type?: ActivityTaskType | null;
2089
+ attachments_count?: number;
2090
+ task_action?: ActivityTaskActionOutput | null;
2091
+ task_action_type?: string | null;
2092
+ is_manual_task?: boolean | null;
2093
+ activity_name?: string | null;
2094
+ period_display_id?: string | null;
2095
+ activity_definition_id?: string | null;
2096
+ task_action_execution_errors?: Array<ActivityTaskActionExecutionError> | null;
2097
+ };
2098
+ type ActivityTaskInstanceWithActivity = {
2099
+ last_manually_updated?: string | null;
2100
+ created_at?: string | null;
2101
+ last_modified_at?: string | null;
2102
+ id: string;
2103
+ name: string;
2104
+ due_date: string;
2105
+ preparer_due_date: string;
2106
+ status: ActivityTaskStatus;
2107
+ description?: string | null;
2108
+ task_definition_id: string;
2109
+ activity_instance_id: string;
2110
+ subsidiary_id: number;
2111
+ is_deleted?: boolean;
2112
+ preparer_id?: string | null;
2113
+ assignee_id?: string | null;
2114
+ reconciled?: boolean | null;
2115
+ creator?: ActivityTaskCreator | null;
2116
+ decline_reason?: string | null;
2117
+ trigger_execution_id?: string | null;
2118
+ blocks_tasks?: Array<ActivityTaskBlocking> | null;
2119
+ blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2120
+ is_currently_blocked?: boolean | null;
2121
+ is_blocking_manually_set?: boolean;
2122
+ task_type?: ActivityTaskType | null;
2123
+ attachments_count?: number;
2124
+ task_action?: ActivityTaskActionOutput | null;
2125
+ task_action_type?: string | null;
2126
+ is_manual_task?: boolean | null;
2127
+ activity_name?: string | null;
2128
+ period_display_id?: string | null;
2129
+ activity_definition_id?: string | null;
2130
+ task_action_execution_errors?: Array<ActivityTaskActionExecutionError> | null;
2131
+ activity_instance: ActivityActivityInstance;
2132
+ };
2133
+ type ActivityTaskStatus = 'DONE' | 'PENDING' | 'IN_REVIEW' | 'IN_PROGRESS' | 'CANCELLED' | 'FAILED' | 'DRAFT';
2134
+ /**
2135
+ * The type of the task definition
2136
+ */
2137
+ type ActivityTaskType = 'RECONCILIATION';
2138
+ type ActivityTasksProgress = {
2139
+ done?: number;
2140
+ review?: number;
2141
+ pending?: number;
2142
+ declined?: number;
2143
+ total?: number;
2144
+ };
2145
+ type ActivityTestActionData = {
2146
+ action_type?: 'test_action';
2147
+ name: string;
2148
+ };
2149
+ type ActivityTestActionTemplate = {
2150
+ action_type?: 'test_action';
2151
+ name: string;
2152
+ };
2153
+ type ActivityTestScheduleActionTemplate = {
2154
+ action_type?: 'test_schedule_action';
2155
+ name: string;
2156
+ };
2157
+ type ActivityTimeframe = {
2158
+ tf_type?: ActivityTimeframeType;
2159
+ offset?: number;
2160
+ periods?: number;
2161
+ unit?: ActivityTimeframeUnit;
2162
+ from_date?: string | null;
2163
+ to_date?: string | null;
2164
+ };
2165
+ type ActivityTimeframeType = 'all' | 'custom' | 'full_periods' | 'last_periods' | 'ytd';
2166
+ type ActivityTimeframeUnit = 'day' | 'week' | 'month' | 'quarter' | 'year';
2167
+ type ActivityWriteBackStatusInput = {
2168
+ id: string;
2169
+ transaction_id: string;
2170
+ journal_entry_id: string;
2171
+ status: ActivityJeWriteBackStatus;
2172
+ provider_uid?: string | null;
2173
+ error_message?: string | null;
2174
+ error_type?: ActivityProviderOperationErrorType | null;
2175
+ last_modified_time?: string | null;
2176
+ };
2177
+ type ActivityWriteBackStatusOutput = {
2178
+ id: string;
2179
+ transaction_id: string;
2180
+ journal_entry_id: string;
2181
+ status: ActivityJeWriteBackStatus;
2182
+ provider_uid?: string | null;
2183
+ error_message?: string | null;
2184
+ error_type?: ActivityProviderOperationErrorType | null;
2185
+ last_modified_time?: string | null;
2186
+ readonly display_error_message: string;
2187
+ };
2188
+ type AuditTrailAuditTrailEvent = {
2189
+ id: string;
2190
+ time: string;
2191
+ action: string;
2192
+ actor: AuditTrailAuditTrailEventActor;
2193
+ subsidiary_id: number;
2194
+ target: AuditTrailEntityRef;
2195
+ additional_data?: {
2196
+ [key: string]: unknown;
2197
+ } | null;
2198
+ old_value?: {
2199
+ [key: string]: unknown;
2200
+ } | null;
2201
+ new_value?: {
2202
+ [key: string]: unknown;
2203
+ } | null;
2204
+ message: string;
2205
+ };
2206
+ type AuditTrailAuditTrailEventActor = {
2207
+ entity_id: string | null;
2208
+ entity_type: AuditTrailEventActorType;
2209
+ entity_name?: string | null;
2210
+ [key: string]: unknown | (string | null) | AuditTrailEventActorType | (string | null) | undefined;
2211
+ };
2212
+ type AuditTrailEntityRef = {
2213
+ entity_id: string;
2214
+ entity_type: AuditTrailEntityType;
2215
+ entity_name?: string | null;
2216
+ [key: string]: unknown | string | AuditTrailEntityType | (string | null) | undefined;
2217
+ };
2218
+ type AuditTrailEntityType = 'TENANT' | 'SUBSIDIARY' | 'LEASE' | 'ACTIVITY_DEFINITION' | 'ACTIVITY_INSTANCE' | 'PERIOD_INSTANCE' | 'TASK_DEFINITION' | 'TASK_INSTANCE' | 'TRIGGER' | 'USER' | 'JOURNAL_ENTRY' | 'ACCOUNT' | 'BILL' | 'ICT';
2219
+ type AuditTrailEventActorType = 'USER' | 'TRIGGER' | 'WORKFLOW' | 'SYSTEM';
2220
+ type AuditTrailGetEntityAuditTrailArgs = {
2221
+ target_id: string;
2222
+ target_type: AuditTrailEntityType;
2223
+ include_before?: boolean;
2224
+ include_after?: boolean;
2225
+ };
2226
+ /**
2227
+ * Fiscal calendar domain model with audit timestamps
2228
+ *
2229
+ * Inherits core fields from `FiscalCalendarCreate` and is used as the
2230
+ * persisted/read model across services.
2231
+ */
2232
+ type PeriodManagerFiscalCalendar = {
2233
+ created_at?: string | null;
2234
+ last_modified_at?: string | null;
2235
+ id: string;
2236
+ name: string;
2237
+ start_month: number;
2238
+ subsidiary_id: number;
2239
+ config?: PeriodManagerFiscalCalendarConfig | null;
2240
+ };
2241
+ /**
2242
+ * Configuration options for a fiscal calendar.
2243
+ *
2244
+ * :param shift_backwards: If False (default), the fiscal year name uses the
2245
+ * year from the start date (e.g., 2025-07-01 to 2026-06-30 -> FY 2025).
2246
+ * If True, uses the year from the end date (e.g., FY 2026).
2247
+ * :param force_p_naming: If True, use P01, P02, etc. naming for periods
2248
+ * even for standard January-December calendars.
2249
+ */
2250
+ type PeriodManagerFiscalCalendarConfig = {
2251
+ shift_backwards?: boolean;
2252
+ force_p_naming?: boolean;
2253
+ };
2254
+ type TenancyCurrency = 'United States Dollar' | 'Euro' | 'British Pound Sterling' | 'Indian Rupee' | 'Australian Dollar' | 'Canadian Dollar' | 'New Israeli Shekel' | 'Japanese Yen' | 'Sri Lankan Rupee' | 'New Zealand Dollar' | 'Swedish Krona' | 'South African Rand' | 'Singapore Dollar' | 'Indonesian Rupiah' | 'Danish Krone' | 'Hong Kong Dollar' | 'United Arab Emirates Dirham' | 'Argentine Peso' | 'Brazilian Real' | 'Bulgarian Lev' | 'Chinese Yuan' | 'Colombian Peso' | 'Czech Koruna' | 'Malaysian Ringgit' | 'Mexican Peso' | 'Myanmar Kyat' | 'New Taiwan Dollar' | 'Norwegian Krone' | 'Omani Rial' | 'Philippine Peso' | 'Polish Zloty' | 'Romanian Leu' | 'Swiss Franc' | 'Turkish Lira' | 'Serbian Dinar' | 'Hungarian Forint' | 'South Korean Won' | 'Armenian Dram' | 'Azerbaijani Manat' | 'Bahraini Dinar' | 'Chilean Peso' | 'Fijian Dollar' | 'Georgian Lari' | 'Guatemalan Quetzal' | 'Croatian Kuna' | 'Icelandic Krona' | 'Jordanian Dinar' | 'Kyrgyzstani Som' | 'Kuwaiti Dinar' | 'Kazakhstani Tenge' | 'Moroccan Dirham' | 'Papua New Guinean Kina' | 'Qatari Rial' | 'Russian Ruble' | 'Saudi Riyal' | 'Thai Baht' | 'Somali Shilling' | 'Tunisian Dinar' | 'Ukrainian Hryvnia' | 'Uzbekistani Som' | 'Vietnamese Dong' | 'Central African CFA Franc' | 'Afghani' | 'Lek' | 'Kwanza' | 'Aruban Florin' | 'Convertible Mark' | 'Barbados Dollar' | 'Taka' | 'Burundi Franc' | 'Bermudian Dollar' | 'Brunei Dollar' | 'Boliviano' | 'Mvdol' | 'Bahamian Dollar' | 'Ngultrum' | 'Pula' | 'Belarusian Ruble' | 'Belize Dollar' | 'Congolese Franc' | 'WIR Euro' | 'WIR Franc' | 'Unidad de Fomento' | 'Unidad de Valor Real' | 'Costa Rican Colon' | 'Cuban Peso' | 'Cabo Verde Escudo' | 'Djibouti Franc' | 'Dominican Peso' | 'Algerian Dinar' | 'Egyptian Pound' | 'Nakfa' | 'Ethiopian Birr' | 'Falkland Islands Pound' | 'Ghana Cedi' | 'Gibraltar Pound' | 'Dalasi' | 'Guinean Franc' | 'Guyana Dollar' | 'Lempira' | 'Gourde' | 'Iraqi Dinar' | 'Iranian Rial' | 'Jamaican Dollar' | 'Kenyan Shilling' | 'Riel' | 'Comorian Franc' | 'North Korean Won' | 'Cayman Islands Dollar' | 'Lao Kip' | 'Lebanese Pound' | 'Liberian Dollar' | 'Loti' | 'Libyan Dinar' | 'Moldovan Leu' | 'Malagasy Ariary' | 'Denar' | 'Tugrik' | 'Pataca' | 'Ouguiya' | 'Mauritius Rupee' | 'Rufiyaa' | 'Malawi Kwacha' | 'Mexican Unidad de Inversion (UDI)' | 'Mozambique Metical' | 'Namibia Dollar' | 'Naira' | 'Cordoba Oro' | 'Nepalese Rupee' | 'Balboa' | 'Sol' | 'Pakistan Rupee' | 'Guarani' | 'Rwanda Franc' | 'Solomon Islands Dollar' | 'Seychelles Rupee' | 'Sudanese Pound' | 'Saint Helena Pound' | 'Leone' | 'Surinam Dollar' | 'South Sudanese Pound' | 'Dobra' | 'El Salvador Colon' | 'Syrian Pound' | 'Lilangeni' | 'Somoni' | 'Turkmenistan New Manat' | "Pa'anga" | 'Trinidad and Tobago Dollar' | 'Tanzanian Shilling' | 'Uganda Shilling' | 'US Dollar (Next day)' | 'Uruguay Peso en Unidades Indexadas (UI)' | 'Peso Uruguayo' | 'Unidad Previsional' | 'Bolivar Digital' | 'Bolivar Soberano' | 'Vatu' | 'Tala' | 'Arab Accounting Dinar' | 'Silver' | 'Gold' | 'Bond Markets Unit European Composite Unit (EURCO)' | 'Bond Markets Unit European Monetary Unit (E.M.U.-6)' | 'Bond Markets Unit European Unit of Account 9 (E.U.A.-9)' | 'Bond Markets Unit European Unit of Account 17 (E.U.A.-17)' | 'East Caribbean Dollar' | 'Caribbean Guilder' | 'SDR (Special Drawing Right)' | 'CFA Franc BCEAO' | 'Palladium' | 'CFP Franc' | 'Platinum' | 'Sucre' | 'Codes specifically reserved for testing purposes' | 'ADB Unit of Account' | 'The codes assigned for transactions where no currency is involved' | 'Yemeni Rial' | 'Zambian Kwacha' | 'Zimbabwe Gold';
2255
+ type TenancySubsidiary = {
2256
+ company_name: string;
2257
+ legal_name: string;
2258
+ description?: string | null;
2259
+ created_time?: string | null;
2260
+ modified_time?: string | null;
2261
+ fully_synced?: boolean;
2262
+ is_active?: boolean;
2263
+ business_summary?: string | null;
2264
+ id?: number | null;
2265
+ default_currency: TenancyCurrency;
2266
+ tenant_id: string;
2267
+ parent_company_id?: number | null;
2268
+ provider_id?: number | null;
2269
+ children?: Array<TenancySubsidiaryCreate>;
2270
+ is_elimination_subsidiary?: boolean | null;
2271
+ is_organization_top?: boolean | null;
2272
+ organization_id?: number | null;
2273
+ provider_uid?: string | null;
2274
+ parent_company?: TenancySubsidiary | null;
2275
+ attachments?: Array<TenancySubsidiaryAttachment>;
2276
+ };
2277
+ type TenancySubsidiaryApiResponse = {
2278
+ company_name: string;
2279
+ legal_name: string;
2280
+ description?: string | null;
2281
+ created_time?: string | null;
2282
+ modified_time?: string | null;
2283
+ fully_synced?: boolean;
2284
+ is_active?: boolean;
2285
+ business_summary?: string | null;
2286
+ id?: number | null;
2287
+ default_currency: TenancyCurrency;
2288
+ tenant_id: string;
2289
+ parent_company_id?: number | null;
2290
+ provider_id?: number | null;
2291
+ children?: Array<TenancySubsidiaryCreate>;
2292
+ is_elimination_subsidiary?: boolean | null;
2293
+ is_organization_top?: boolean | null;
2294
+ organization_id?: number | null;
2295
+ provider_uid?: string | null;
2296
+ parent_company?: TenancySubsidiary | null;
2297
+ attachments?: Array<TenancySubsidiaryAttachment>;
2298
+ is_organization?: boolean;
2299
+ is_parent_subsidiary?: boolean;
2300
+ is_nominal_subsidiary?: boolean;
2301
+ };
2302
+ type TenancySubsidiaryAttachment = {
2303
+ attachment_id: string;
2304
+ attachment_type: TenancySubsidiaryAttachmentType;
2305
+ attachment_date?: string;
2306
+ processing_status?: TenancySubsidiaryAttachmentProcessingStatus;
2307
+ error_message?: string | null;
2308
+ should_use_top_coa?: boolean;
2309
+ created_time?: string | null;
2310
+ };
2311
+ type TenancySubsidiaryAttachmentProcessingStatus = 'PENDING' | 'ACTIVE' | 'FAILED';
2312
+ type TenancySubsidiaryAttachmentType = 'BVA';
2313
+ type TenancySubsidiaryCreate = {
2314
+ company_name: string;
2315
+ legal_name: string;
2316
+ description?: string | null;
2317
+ created_time?: string | null;
2318
+ modified_time?: string | null;
2319
+ fully_synced?: boolean;
2320
+ is_active?: boolean;
2321
+ business_summary?: string | null;
2322
+ id?: number | null;
2323
+ default_currency: TenancyCurrency;
2324
+ tenant_id: string;
2325
+ parent_company_id?: number | null;
2326
+ provider_id?: number | null;
2327
+ children?: Array<TenancySubsidiaryCreate>;
2328
+ is_elimination_subsidiary?: boolean | null;
2329
+ is_organization_top?: boolean | null;
2330
+ organization_id?: number | null;
2331
+ provider_uid?: string | null;
2332
+ };
2333
+ type TenancyUser = {
2334
+ id?: string;
2335
+ email?: string;
2336
+ name?: string;
2337
+ status?: TenancyUserStatus;
2338
+ picture?: string;
2339
+ custom_attributes?: {
2340
+ [key: string]: unknown;
2341
+ };
2342
+ };
2343
+ type TenancyUserStatus = 'invited' | 'enabled' | 'disabled';
2344
+ type GetAccountsApiAccountingAccountGetData = {
2345
+ body?: never;
2346
+ path?: never;
2347
+ query?: {
2348
+ account_ids?: Array<string> | null;
2349
+ };
2350
+ url: '/api/accounting/account';
2351
+ };
2352
+ type GetAccountsApiAccountingAccountGetResponses = {
2353
+ /**
2354
+ * Successful Response
2355
+ */
2356
+ 200: Array<AccountingTAccountOutput>;
2357
+ };
2358
+ type GetAccountsApiAccountingAccountGetResponse = GetAccountsApiAccountingAccountGetResponses[keyof GetAccountsApiAccountingAccountGetResponses];
2359
+ type GetAccountApiAccountingAccountAccountIdGetData = {
2360
+ body?: never;
2361
+ path: {
2362
+ account_id: string;
2363
+ };
2364
+ query?: never;
2365
+ url: '/api/accounting/account/{account_id}';
2366
+ };
2367
+ type GetAccountApiAccountingAccountAccountIdGetResponses = {
2368
+ /**
2369
+ * Successful Response
2370
+ */
2371
+ 200: AccountingTAccountWithSubAccounts;
2372
+ };
2373
+ type GetAccountApiAccountingAccountAccountIdGetResponse = GetAccountApiAccountingAccountAccountIdGetResponses[keyof GetAccountApiAccountingAccountAccountIdGetResponses];
2374
+ type GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetData = {
2375
+ body?: never;
2376
+ path: {
2377
+ subsidiary_id: number;
2378
+ };
2379
+ query?: {
2380
+ account_subsidiary_ids?: Array<number>;
2381
+ from_date?: string;
2382
+ to_date?: string;
2383
+ ignore_elimination_balance?: boolean;
2384
+ is_normalized?: boolean;
2385
+ };
2386
+ url: '/api/accounting/subsidiary/{subsidiary_id}/coa';
2387
+ };
2388
+ type GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponses = {
2389
+ /**
2390
+ * Successful Response
2391
+ */
2392
+ 200: Array<AccountingTAccountWithSubAccounts>;
2393
+ };
2394
+ type GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponse = GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponses[keyof GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponses];
2395
+ type GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetData = {
2396
+ body?: AccountingPaginationPositionInput | null;
2397
+ path: {
2398
+ subsidiary_id: number;
2399
+ };
2400
+ query?: {
2401
+ account_subsidiary_ids?: Array<number>;
2402
+ account_type?: Array<AccountingAccountType>;
2403
+ accounting_class?: Array<AccountingAccountingClass>;
2404
+ exclude_account_ids?: Array<string>;
2405
+ from_date?: string;
2406
+ to_date?: string;
2407
+ with_direct_balance?: boolean;
2408
+ with_no_balance?: boolean;
2409
+ ignore_elimination_balance?: boolean;
2410
+ is_normalized?: boolean;
2411
+ page?: number | null;
2412
+ per_page?: number | null;
2413
+ include_total?: boolean;
2414
+ sort?: AccountingSortableFieldsCoa;
2415
+ order?: AccountingSortingOrder | null;
2416
+ q?: string | null;
2417
+ };
2418
+ url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account';
2419
+ };
2420
+ type GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponses = {
2421
+ /**
2422
+ * Successful Response
2423
+ */
2424
+ 200: AccountingCoaPaginationOutput | Array<AccountingTAccountOutput>;
2425
+ };
2426
+ type GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponse = GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponses[keyof GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponses];
2427
+ type GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetData = {
2428
+ body?: never;
2429
+ path: {
2430
+ subsidiary_id: number;
2431
+ };
2432
+ query?: {
2433
+ ignore_inactive_accounts?: boolean;
2434
+ };
2435
+ url: '/api/accounting/subsidiary/{subsidiary_id}/coa/available-currencies';
2436
+ };
2437
+ type GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponses = {
2438
+ /**
2439
+ * Successful Response
2440
+ */
2441
+ 200: Array<AccountingCurrency>;
2442
+ };
2443
+ type GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponse = GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponses[keyof GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponses];
2444
+ type GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetData = {
2445
+ body?: AccountingPaginationPositionInput | null;
2446
+ path: {
2447
+ subsidiary_id: number;
2448
+ };
2449
+ query?: {
2450
+ account_subsidiary_ids?: Array<number>;
2451
+ account_ids?: Array<string>;
2452
+ exclude_account_ids?: Array<string>;
2453
+ account_type?: Array<AccountingAccountType>;
2454
+ accounting_class?: Array<AccountingAccountingClass>;
2455
+ ignore_elimination_balance?: boolean;
2456
+ ignore_inactive_accounts?: boolean;
2457
+ is_normalized?: boolean;
2458
+ page?: number | null;
2459
+ per_page?: number | null;
2460
+ include_total?: boolean;
2461
+ sort?: AccountingSortableFieldsCoa;
2462
+ order?: AccountingSortingOrder | null;
2463
+ q?: string | null;
2464
+ };
2465
+ url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account/simple';
2466
+ };
2467
+ type GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponses = {
2468
+ /**
2469
+ * Successful Response
2470
+ */
2471
+ 200: AccountingSimpleCoAPaginationOutput | Array<AccountingSimpleTAccount>;
2472
+ };
2473
+ type GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponse = GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponses[keyof GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponses];
2474
+ type GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetData = {
2475
+ body?: never;
2476
+ path: {
2477
+ subsidiary_id: number;
2478
+ };
2479
+ query: {
2480
+ group_by: AccountingCoAGroupBy;
2481
+ account_subsidiary_ids?: Array<number>;
2482
+ from_date?: string;
2483
+ to_date?: string;
2484
+ with_direct_balance?: boolean;
2485
+ ignore_elimination_balance?: boolean;
2486
+ is_normalized?: boolean;
2487
+ };
2488
+ url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account/group';
2489
+ };
2490
+ type GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponses = {
2491
+ /**
2492
+ * Successful Response
2493
+ */
2494
+ 200: Array<AccountingGroupedAccounts>;
2495
+ };
2496
+ type GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponse = GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponses[keyof GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponses];
2497
+ type GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetData = {
2498
+ body?: never;
2499
+ path: {
2500
+ subsidiary_id: number;
2501
+ account_id: string;
2502
+ };
2503
+ query?: {
2504
+ is_normalized?: boolean;
2505
+ from_date?: string;
2506
+ to_date?: string;
2507
+ };
2508
+ url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account/{account_id}';
2509
+ };
2510
+ type GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponses = {
2511
+ /**
2512
+ * Successful Response
2513
+ */
2514
+ 200: AccountingTAccountWithSubAccounts;
2515
+ };
2516
+ type GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponse = GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponses[keyof GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponses];
2517
+ type GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetData = {
2518
+ body?: never;
2519
+ path: {
2520
+ currency: AccountingCurrency;
2521
+ };
2522
+ query?: {
2523
+ exchange_date?: string;
2524
+ };
2525
+ url: '/api/accounting/currency/{currency}/conversion-rates';
2526
+ };
2527
+ type GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponses = {
2528
+ /**
2529
+ * Successful Response
2530
+ */
2531
+ 200: AccountingExchangeRates;
2532
+ };
2533
+ type GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponse = GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponses[keyof GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponses];
2534
+ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetData = {
2535
+ body?: AccountingPaginationPositionInput | null;
2536
+ path: {
2537
+ subsidiary_id: number;
2538
+ };
2539
+ query?: {
2540
+ entry_types?: Array<AccountingJournalEntryType> | null;
2541
+ ref_numbers?: Array<string> | null;
2542
+ child_subsidiaries?: Array<number> | null;
2543
+ from_date?: string | null;
2544
+ to_date?: string | null;
2545
+ is_nominal_ledger?: boolean | null;
2546
+ memo?: string | null;
2547
+ journal_entry_line_ids?: Array<string> | null;
2548
+ page?: number | null;
2549
+ per_page?: number | null;
2550
+ include_total?: boolean;
2551
+ sort?: 'date' | 'transaction_type' | 'memo' | 'ref_number';
2552
+ order?: AccountingSortingOrder | null;
2553
+ };
2554
+ url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry/lines';
2555
+ };
2556
+ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses = {
2557
+ /**
2558
+ * Successful Response
2559
+ */
2560
+ 200: Array<AccountingJournalEntryLineWithJournalEntryWithDimensionsWithOperationCtx> | AccountingJournalEntryLinePaginationOutput;
2561
+ };
2562
+ type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponse = GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses[keyof GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses];
2563
+ type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData = {
2564
+ body?: AccountingPaginationPositionInput | null;
2565
+ path: {
2566
+ subsidiary_id: number;
2567
+ };
2568
+ query?: {
2569
+ entry_types?: Array<AccountingJournalEntryType> | null;
2570
+ ref_numbers?: Array<string> | null;
2571
+ child_subsidiaries?: Array<number> | null;
2572
+ from_date?: string | null;
2573
+ to_date?: string | null;
2574
+ is_nominal_ledger?: boolean | null;
2575
+ memo?: string | null;
2576
+ entry_statuses?: Array<AccountingJournalEntryStatus> | null;
2577
+ /**
2578
+ * Filter entries where any line has this amount
2579
+ */
2580
+ line_amount?: number | null;
2581
+ page?: number | null;
2582
+ per_page?: number | null;
2583
+ include_total?: boolean;
2584
+ sort?: 'date' | 'transaction_type' | 'memo' | 'ref_number';
2585
+ order?: AccountingSortingOrder | null;
2586
+ };
2587
+ url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry';
2588
+ };
2589
+ type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponses = {
2590
+ /**
2591
+ * Successful Response
2592
+ */
2593
+ 200: Array<AccountingJournalEntryDimensionsWithOperationCtx> | AccountingJournalEntryPaginationOutput;
2594
+ };
2595
+ type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponse = GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponses[keyof GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponses];
2596
+ type GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetData = {
2597
+ body?: never;
2598
+ path: {
2599
+ journal_entry_id: string;
2600
+ subsidiary_id: number;
2601
+ };
2602
+ query?: never;
2603
+ url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry/{journal_entry_id}';
2604
+ };
2605
+ type GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponses = {
2606
+ /**
2607
+ * Successful Response
2608
+ */
2609
+ 200: AccountingJournalEntryDimensionsWithOperationCtx;
2610
+ };
2611
+ type GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponse = GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponses[keyof GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponses];
2612
+ type GetDimensionsApiAccountingDimensionGetData = {
2613
+ body?: never;
2614
+ path?: never;
2615
+ query?: {
2616
+ subsidiary_id?: number | null;
2617
+ values_limit?: number | null;
2618
+ with_rules_and_values?: boolean;
2619
+ };
2620
+ url: '/api/accounting/dimension';
2621
+ };
2622
+ type GetDimensionsApiAccountingDimensionGetResponses = {
2623
+ /**
2624
+ * Successful Response
2625
+ */
2626
+ 200: Array<AccountingDimensionWithRules>;
2627
+ };
2628
+ type GetDimensionsApiAccountingDimensionGetResponse = GetDimensionsApiAccountingDimensionGetResponses[keyof GetDimensionsApiAccountingDimensionGetResponses];
2629
+ type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetData = {
2630
+ body?: never;
2631
+ path: {
2632
+ dimension_id: string;
2633
+ account_id: string;
2634
+ };
2635
+ query?: never;
2636
+ url: '/api/accounting/dimension/{dimension_id}/account/{account_id}';
2637
+ };
2638
+ type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponses = {
2639
+ /**
2640
+ * Successful Response
2641
+ */
2642
+ 200: AccountingAccountDimensionValues;
2643
+ };
2644
+ type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponse = GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponses[keyof GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponses];
2645
+ type GetDimensionValuesApiAccountingDimensionValueGetData = {
2646
+ body?: never;
2647
+ path?: never;
2648
+ query?: {
2649
+ dimension_ids?: Array<string> | null;
2650
+ dimension_value_ids?: Array<string> | null;
2651
+ dimension_name?: string | null;
2652
+ dimension_value?: string | null;
2653
+ slim?: boolean;
2654
+ /**
2655
+ * Sort dimension values alphabetically by value
2656
+ */
2657
+ sort_alphabetically?: boolean;
2658
+ };
2659
+ url: '/api/accounting/dimension-value';
2660
+ };
2661
+ type GetDimensionValuesApiAccountingDimensionValueGetResponses = {
2662
+ /**
2663
+ * Successful Response
2664
+ */
2665
+ 200: Array<AccountingDimensionValueWithRulesAndChildren | AccountingDimensionValueSlim | AccountingDimensionValue> | [
2666
+ Array<AccountingDimensionValueWithRulesAndChildren | AccountingDimensionValueSlim | AccountingDimensionValue>,
2667
+ AccountingPaginationOutput
2668
+ ];
2669
+ };
2670
+ type GetDimensionValuesApiAccountingDimensionValueGetResponse = GetDimensionValuesApiAccountingDimensionValueGetResponses[keyof GetDimensionValuesApiAccountingDimensionValueGetResponses];
2671
+ type GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetData = {
2672
+ body?: never;
2673
+ path?: never;
2674
+ query?: {
2675
+ dimension_id?: string | null;
2676
+ dimension_name?: string | null;
2677
+ parent_id?: string | null;
2678
+ search_query?: string | null;
2679
+ include_ids?: Array<string> | null;
2680
+ slim?: boolean;
2681
+ };
2682
+ url: '/api/accounting/dimension-value/hierarchical';
2683
+ };
2684
+ type GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponses = {
2685
+ /**
2686
+ * Successful Response
2687
+ */
2688
+ 200: [
2689
+ Array<AccountingDimensionValueWithChildren> | Array<AccountingDimensionValueSlim>,
2690
+ AccountingPaginationOutput | null
2691
+ ];
2692
+ };
2693
+ type GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponse = GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponses[keyof GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponses];
2694
+ type GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetData = {
2695
+ body?: AccountingPaginationPositionInput | null;
2696
+ path?: never;
2697
+ query?: {
2698
+ from_subsidiary?: Array<number> | null;
2699
+ to_subsidiary?: Array<number> | null;
2700
+ page?: number | null;
2701
+ per_page?: number | null;
2702
+ include_total?: boolean;
2703
+ sort?: AccountingSortableFieldsCer;
2704
+ order?: AccountingSortingOrder | null;
2705
+ };
2706
+ url: '/api/accounting/consolidation-exchange-rate';
2707
+ };
2708
+ type GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponses = {
2709
+ /**
2710
+ * Successful Response
2711
+ */
2712
+ 200: AccountingCerPaginationOutput;
2713
+ };
2714
+ type GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponse = GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponses[keyof GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponses];
2715
+ type GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetData = {
2716
+ body?: never;
2717
+ path: {
2718
+ input_date: string;
2719
+ };
2720
+ query?: never;
2721
+ url: '/api/accounting/consolidation-exchange-rate/period/{input_date}';
2722
+ };
2723
+ type GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponses = {
2724
+ /**
2725
+ * Successful Response
2726
+ */
2727
+ 200: AccountingConsolidationExchangeRatePeriod;
2728
+ };
2729
+ type GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponse = GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponses[keyof GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponses];
2730
+ type GetActivityDefinitionsApiActivityActivityDefinitionGetData = {
2731
+ body?: never;
2732
+ path?: never;
2733
+ query?: {
2734
+ with_disabled_activity?: boolean;
2735
+ with_task_definitions?: boolean;
2736
+ };
2737
+ url: '/api/activity/activity-definition';
2738
+ };
2739
+ type GetActivityDefinitionByIdApiActivityActivityDefinitionActivityDefinitionIdGetData = {
2740
+ body?: never;
2741
+ path: {
2742
+ activity_definition_id: string;
2743
+ };
2744
+ query?: {
2745
+ with_task_definitions?: boolean;
2746
+ };
2747
+ url: '/api/activity/activity-definition/{activity_definition_id}';
2748
+ };
2749
+ type GetPeriodInstancesApiActivityPeriodInstanceGetData = {
2750
+ body?: never;
2751
+ path?: never;
2752
+ query?: {
2753
+ period?: ActivityPeriod | null;
2754
+ slim?: boolean;
2755
+ from_date?: string | null;
2756
+ to_date?: string | null;
2757
+ ref_date?: string | null;
2758
+ };
2759
+ url: '/api/activity/period-instance';
2760
+ };
2761
+ type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
2762
+ body?: never;
2763
+ path: {
2764
+ period_instance_id: string;
2765
+ };
2766
+ query?: {
2767
+ with_disabled_activity?: boolean;
2768
+ include_children?: boolean;
2769
+ subsidiary_ids?: Array<number> | null;
2770
+ };
2771
+ url: '/api/activity/period-instance/{period_instance_id}';
2772
+ };
2773
+ type GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData = {
2774
+ body?: never;
2775
+ path: {
2776
+ period_display_id: string;
2777
+ };
2778
+ query?: {
2779
+ with_disabled_activity?: boolean;
2780
+ include_children?: boolean;
2781
+ subsidiary_ids?: Array<number> | null;
2782
+ /**
2783
+ * Filter by activity definition IDs
2784
+ */
2785
+ activity_definition_ids?: Array<string> | null;
2786
+ exclude_task_types?: Array<ActivityTaskType> | null;
2787
+ include_task_types?: Array<ActivityTaskType> | null;
2788
+ };
2789
+ url: '/api/activity/period-instance/by-slug/{period_display_id}';
2790
+ };
2791
+ type GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetData = {
2792
+ body?: never;
2793
+ path: {
2794
+ period_display_id: string;
2795
+ };
2796
+ query?: {
2797
+ /**
2798
+ * Maximum number of subsidiaries to return globally (max 50)
2799
+ */
2800
+ max_subsidiaries?: number;
2801
+ /**
2802
+ * Filter by specific subsidiary IDs
2803
+ */
2804
+ subsidiary_ids?: Array<number> | null;
2805
+ /**
2806
+ * Filter by activity definition IDs
2807
+ */
2808
+ activity_definition_ids?: Array<string> | null;
2809
+ };
2810
+ url: '/api/activity/period-instance/by-slug/{period_display_id}/progress-breakdown';
2811
+ };
2812
+ type GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponses = {
2813
+ /**
2814
+ * Successful Response
2815
+ */
2816
+ 200: ActivityPeriodInstanceProgressBreakdownApi;
2817
+ };
2818
+ type GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponse = GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponses[keyof GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponses];
2819
+ type GetAllTasksDefinitionsApiActivityTaskDefinitionGetData = {
2820
+ body?: never;
2821
+ path?: never;
2822
+ query?: {
2823
+ entity_id?: string | null;
2824
+ with_instances?: boolean;
2825
+ };
2826
+ url: '/api/activity/task-definition';
2827
+ };
2828
+ type GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponses = {
2829
+ /**
2830
+ * Successful Response
2831
+ */
2832
+ 200: Array<ActivitySlimTaskDefinitionWithInstances>;
2833
+ };
2834
+ type GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponse = GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponses[keyof GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponses];
2835
+ type CreateTaskDefinitionApiActivityTaskDefinitionPostData = {
2836
+ body: ActivityTaskDefinitionWithActionCreateApi;
2837
+ path?: never;
2838
+ query?: never;
2839
+ url: '/api/activity/task-definition';
2840
+ };
2841
+ type CreateTaskDefinitionApiActivityTaskDefinitionPostResponses = {
2842
+ /**
2843
+ * Successful Response
2844
+ */
2845
+ 200: ActivityTaskDefinition;
2846
+ };
2847
+ type CreateTaskDefinitionApiActivityTaskDefinitionPostResponse = CreateTaskDefinitionApiActivityTaskDefinitionPostResponses[keyof CreateTaskDefinitionApiActivityTaskDefinitionPostResponses];
2848
+ type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
2849
+ body?: never;
2850
+ path?: never;
2851
+ query?: {
2852
+ entity_ids?: Array<string>;
2853
+ entity_type?: ActivityTaskEntityType | null;
2854
+ with_instances?: boolean;
2855
+ q?: string | null;
2856
+ };
2857
+ url: '/api/activity/task-definition/query';
2858
+ };
2859
+ type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponses = {
2860
+ /**
2861
+ * Successful Response
2862
+ */
2863
+ 200: Array<ActivitySlimTaskDefinitionWithInstances>;
2864
+ };
2865
+ type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponse = GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponses[keyof GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponses];
2866
+ type GetTaskDefinitionByIdApiActivityTaskDefinitionTaskDefinitionIdGetData = {
2867
+ body?: never;
2868
+ path: {
2869
+ task_definition_id: string;
2870
+ };
2871
+ query?: {
2872
+ include_draft?: boolean;
2873
+ with_instances?: boolean;
2874
+ with_action_template?: boolean;
2875
+ };
2876
+ url: '/api/activity/task-definition/{task_definition_id}';
2877
+ };
2878
+ type UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutData = {
2879
+ body: ActivityTaskDefinitionUpdate;
2880
+ path: {
2881
+ task_definition_id: string;
2882
+ };
2883
+ query?: {
2884
+ should_override_instances?: boolean;
2885
+ };
2886
+ url: '/api/activity/task-definition/{task_definition_id}';
2887
+ };
2888
+ type UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponses = {
2889
+ /**
2890
+ * Successful Response
2891
+ */
2892
+ 200: ActivityTaskDefinition;
2893
+ };
2894
+ type UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponse = UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponses[keyof UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponses];
2895
+ type GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData = {
2896
+ body?: never;
2897
+ path: {
2898
+ activity_instance_id: string;
2899
+ };
2900
+ query?: {
2901
+ with_slim_task_instances?: boolean;
2902
+ with_instances?: boolean;
2903
+ for_reconciliation?: boolean;
2904
+ subsidiary_ids?: Array<number> | null;
2905
+ };
2906
+ url: '/api/activity/activity-instance/{activity_instance_id}';
2907
+ };
2908
+ type GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTaskGetData = {
2909
+ body?: ActivityPaginationPositionInput | null;
2910
+ path: {
2911
+ activity_instance_id: string;
2912
+ };
2913
+ query?: {
2914
+ is_deleted?: boolean | null;
2915
+ include_draft?: boolean;
2916
+ subsidiary_ids?: Array<number> | null;
2917
+ status?: Array<ActivityTaskStatus> | null;
2918
+ preparer_ids?: Array<string> | null;
2919
+ reviewer_ids?: Array<string> | null;
2920
+ due_date_period?: ActivityPeriodFilter;
2921
+ due_date_from?: string;
2922
+ due_date_to?: string;
2923
+ slim?: boolean;
2924
+ without_activity_instance?: boolean;
2925
+ page?: number | null;
2926
+ per_page?: number | null;
2927
+ include_total?: boolean;
2928
+ sort?: ActivitySortableFieldsTask;
2929
+ order?: ActivitySortingOrder | null;
2930
+ q?: string | null;
2931
+ };
2932
+ url: '/api/activity/activity-instance/{activity_instance_id}/task';
2933
+ };
2934
+ type GetActivityInstancesApiActivityActivityInstanceGetData = {
2935
+ body?: never;
2936
+ path?: never;
2937
+ query?: {
2938
+ period_instance_id?: string | null;
2939
+ activity_definition_id?: string | null;
2940
+ from_date?: string | null;
2941
+ to_date?: string | null;
2942
+ as_enriched?: boolean;
2943
+ };
2944
+ url: '/api/activity/activity-instance';
2945
+ };
2946
+ type GetActivityInstancesApiActivityActivityInstanceGetResponses = {
2947
+ /**
2948
+ * Successful Response
2949
+ */
2950
+ 200: Array<ActivityApiEnrichedActivityInstance | ActivityActivityInstanceWithTaskInstances>;
2951
+ };
2952
+ type GetActivityInstancesApiActivityActivityInstanceGetResponse = GetActivityInstancesApiActivityActivityInstanceGetResponses[keyof GetActivityInstancesApiActivityActivityInstanceGetResponses];
2953
+ type GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetData = {
2954
+ body?: never;
2955
+ path: {
2956
+ period_display_id: string;
2957
+ activity_definition_id: string;
2958
+ };
2959
+ query?: {
2960
+ with_slim_task_instances?: boolean;
2961
+ with_instances?: boolean;
2962
+ for_reconciliation?: boolean;
2963
+ subsidiary_ids?: Array<number> | null;
2964
+ };
2965
+ url: '/api/activity/activity-instance/by-period/{period_display_id}/{activity_definition_id}';
2966
+ };
2967
+ type GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponses = {
2968
+ /**
2969
+ * Successful Response
2970
+ */
2971
+ 200: ActivityApiEnrichedActivityInstance;
2972
+ };
2973
+ type GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponse = GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponses[keyof GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponses];
2974
+ type GetTaskInstancesByActivityPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdTaskGetData = {
2975
+ body?: ActivityPaginationPositionInput | null;
2976
+ path: {
2977
+ period_display_id: string;
2978
+ activity_definition_id: string;
2979
+ };
2980
+ query?: {
2981
+ is_deleted?: boolean | null;
2982
+ include_draft?: boolean;
2983
+ subsidiary_ids?: Array<number> | null;
2984
+ status?: Array<ActivityTaskStatus> | null;
2985
+ preparer_ids?: Array<string> | null;
2986
+ reviewer_ids?: Array<string> | null;
2987
+ slim?: boolean;
2988
+ without_activity_instance?: boolean;
2989
+ exclude_task_types?: Array<ActivityTaskType> | null;
2990
+ page?: number | null;
2991
+ per_page?: number | null;
2992
+ include_total?: boolean;
2993
+ sort?: ActivitySortableFieldsTask;
2994
+ order?: ActivitySortingOrder | null;
2995
+ q?: string | null;
2996
+ };
2997
+ url: '/api/activity/activity-instance/by-period/{period_display_id}/{activity_definition_id}/task';
2998
+ };
2999
+ type GetAllTaskInstancesApiActivityTaskInstanceGetData = {
3000
+ body?: never;
3001
+ path?: never;
3002
+ query?: {
3003
+ status?: Array<ActivityTaskStatus>;
3004
+ subsidiary_ids?: Array<number>;
3005
+ activity_definition_ids?: Array<string>;
3006
+ preparer_ids?: Array<string> | null;
3007
+ reviewer_ids?: Array<string> | null;
3008
+ period_instance_id?: string | null;
3009
+ period_display_id?: string | null;
3010
+ period_instance_ids?: Array<string> | null;
3011
+ period_display_ids?: Array<string> | null;
3012
+ exclude_task_types?: Array<ActivityTaskType> | null;
3013
+ slim?: boolean;
3014
+ sort?: ActivitySortableFieldsTask;
3015
+ order?: ActivitySortingOrder | null;
3016
+ q?: string | null;
3017
+ };
3018
+ url: '/api/activity/task-instance';
3019
+ };
3020
+ type GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostData = {
3021
+ body?: ActivityBodyGetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPost;
3022
+ path?: never;
3023
+ query?: {
3024
+ sort?: ActivitySortableFieldsTask;
3025
+ order?: ActivitySortingOrder | null;
3026
+ };
3027
+ url: '/api/activity/task-instance/query';
3028
+ };
3029
+ type GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponses = {
3030
+ /**
3031
+ * Successful Response
3032
+ */
3033
+ 200: ActivityTaskInstancePaginationOutput;
3034
+ };
3035
+ type GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponse = GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponses[keyof GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponses];
3036
+ type GetTaskInstanceByIdApiActivityTaskInstanceTaskInstanceIdGetData = {
3037
+ body?: never;
3038
+ path: {
3039
+ task_instance_id: string;
3040
+ };
3041
+ query?: {
3042
+ with_task_action?: boolean;
3043
+ };
3044
+ url: '/api/activity/task-instance/{task_instance_id}';
3045
+ };
3046
+ type UpdateTaskInstanceApiActivityTaskInstanceTaskInstanceIdPutData = {
3047
+ body: ActivityTaskInstanceUpdateWithAction | ActivityTaskInstanceUpdateClearAction | ActivityTaskInstanceUpdate;
3048
+ path: {
3049
+ task_instance_id: string;
3050
+ };
3051
+ query?: never;
3052
+ url: '/api/activity/task-instance/{task_instance_id}';
3053
+ };
3054
+ type GetEventsApiAuditTrailEventGetData = {
3055
+ body?: never;
3056
+ path?: never;
3057
+ query?: never;
3058
+ url: '/api/audit-trail/event';
3059
+ };
3060
+ type GetEventsApiAuditTrailEventGetResponses = {
3061
+ /**
3062
+ * Successful Response
3063
+ */
3064
+ 200: Array<AuditTrailAuditTrailEvent>;
3065
+ };
3066
+ type GetEventsApiAuditTrailEventGetResponse = GetEventsApiAuditTrailEventGetResponses[keyof GetEventsApiAuditTrailEventGetResponses];
3067
+ type GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostData = {
3068
+ body?: Array<AuditTrailGetEntityAuditTrailArgs> | null;
3069
+ path: {
3070
+ target_type: AuditTrailEntityType;
3071
+ target_id: string;
3072
+ };
3073
+ query?: never;
3074
+ url: '/api/audit-trail/event/entity/{target_type}/{target_id}';
3075
+ };
3076
+ type GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponses = {
3077
+ /**
3078
+ * Successful Response
3079
+ */
3080
+ 200: Array<AuditTrailAuditTrailEvent>;
3081
+ };
3082
+ type GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponse = GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponses[keyof GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponses];
3083
+ type GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetData = {
3084
+ body?: never;
3085
+ path: {
3086
+ subsidiary_id: number;
3087
+ };
3088
+ query?: never;
3089
+ url: '/api/period-manager/fiscal-calendar/by-subsidiary/{subsidiary_id}';
3090
+ };
3091
+ type GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponses = {
3092
+ /**
3093
+ * Successful Response
3094
+ */
3095
+ 200: Array<PeriodManagerFiscalCalendar>;
3096
+ };
3097
+ type GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponse = GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponses[keyof GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponses];
3098
+ type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetData = {
3099
+ body?: never;
3100
+ path: {
3101
+ calendar_id: string;
3102
+ };
3103
+ query?: never;
3104
+ url: '/api/period-manager/fiscal-calendar/{calendar_id}';
3105
+ };
3106
+ type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponses = {
3107
+ /**
3108
+ * Successful Response
3109
+ */
3110
+ 200: PeriodManagerFiscalCalendar;
3111
+ };
3112
+ type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse = GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponses[keyof GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponses];
3113
+ type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData = {
3114
+ body?: never;
3115
+ path: {
3116
+ tenant_id_or_name: string;
3117
+ };
3118
+ query?: never;
3119
+ url: '/api/tenancy/tenant/{tenant_id_or_name}/users';
3120
+ };
3121
+ type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponses = {
3122
+ /**
3123
+ * Successful Response
3124
+ */
3125
+ 200: Array<TenancyUser>;
3126
+ };
3127
+ type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponse = GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponses[keyof GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponses];
3128
+ type GetAllSubsidiariesApiTenancySubsidiaryGetData = {
3129
+ body?: never;
3130
+ path?: never;
3131
+ query?: {
3132
+ is_flat?: boolean;
3133
+ only_active?: boolean;
3134
+ with_elimination_subsidiaries?: boolean;
3135
+ q?: string | null;
3136
+ };
3137
+ url: '/api/tenancy/subsidiary';
3138
+ };
3139
+ type GetAllSubsidiariesApiTenancySubsidiaryGetResponses = {
3140
+ /**
3141
+ * Successful Response
3142
+ */
3143
+ 200: Array<TenancySubsidiaryApiResponse>;
3144
+ };
3145
+ type GetAllSubsidiariesApiTenancySubsidiaryGetResponse = GetAllSubsidiariesApiTenancySubsidiaryGetResponses[keyof GetAllSubsidiariesApiTenancySubsidiaryGetResponses];
3146
+ type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData = {
3147
+ body?: never;
3148
+ path: {
3149
+ subsidiary_id: number;
3150
+ };
3151
+ query?: {
3152
+ with_elimination_subsidiaries?: boolean;
3153
+ };
3154
+ url: '/api/tenancy/subsidiary/{subsidiary_id}';
3155
+ };
3156
+ type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponses = {
3157
+ /**
3158
+ * Successful Response
3159
+ */
3160
+ 200: TenancySubsidiaryApiResponse | null;
3161
+ };
3162
+ type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponse = GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponses[keyof GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponses];
3163
+ type GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetData = {
3164
+ body?: never;
3165
+ path: {
3166
+ subsidiary_id: number;
3167
+ };
3168
+ query?: never;
3169
+ url: '/api/tenancy/subsidiary/{subsidiary_id}/parent-currencies';
3170
+ };
3171
+ type GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponses = {
3172
+ /**
3173
+ * Successful Response
3174
+ */
3175
+ 200: {
3176
+ [key: string]: unknown;
3177
+ };
3178
+ };
3179
+ type GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponse = GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponses[keyof GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponses];
3180
+
3181
+ interface BridgeSubsidiary {
3182
+ id: number;
3183
+ displayName: string;
3184
+ }
3185
+ interface ContextPayload {
3186
+ tenant: string;
3187
+ subsidiaryId: number;
3188
+ subsidiaries: BridgeSubsidiary[];
3189
+ user: {
3190
+ id: string;
3191
+ displayName: string;
3192
+ };
3193
+ /** Initial subroute the iframe should navigate to on first load. */
3194
+ subroute?: string;
3195
+ /** Slug of the last closed accounting period, e.g. "mar-2026". */
3196
+ lastClosedPeriodSlug?: string;
3197
+ /** Version of the host SDK (@nominalso/vibe-host) running in nom-ui. */
3198
+ hostVersion: string;
3199
+ }
3200
+ /** Payload sent by the bridge when requesting context from the host. */
3201
+ interface GetContextPayload {
3202
+ /** Version of the bridge SDK (@nominalso/vibe-bridge) running in the iframe. */
3203
+ bridgeVersion: string;
3204
+ }
3205
+
3206
+ /**
3207
+ * All operations the iframe can invoke on the host, each with a typed request
3208
+ * payload and a typed response. Adding a new operation here is all that's
3209
+ * required — message union types and handler types below are derived
3210
+ * automatically.
3211
+ *
3212
+ * Operations that also emit intermediate progress events should include a
3213
+ * `progress` field with the progress payload type.
3214
+ */
3215
+ interface UploadPayload {
3216
+ buffer: ArrayBuffer;
3217
+ fileName: string;
3218
+ fileType: string;
3219
+ entityType: string;
3220
+ entityId?: string | number;
3221
+ }
3222
+ interface UploadResponse {
3223
+ attachmentId: string;
3224
+ name: string;
3225
+ }
3226
+ interface UploadProgress {
3227
+ attachmentId: string;
3228
+ progress: number;
3229
+ }
3230
+ interface RequestRegistry {
3231
+ GET_CHART_OF_ACCOUNTS: {
3232
+ payload: Omit<GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetData, 'url'>;
3233
+ data: GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponse;
3234
+ };
3235
+ GET_SUBSIDIARIES: {
3236
+ payload: Omit<GetAllSubsidiariesApiTenancySubsidiaryGetData, 'url'>;
3237
+ data: GetAllSubsidiariesApiTenancySubsidiaryGetResponse;
3238
+ };
3239
+ GET_PERIODS: {
3240
+ payload: Omit<GetPeriodInstancesApiActivityPeriodInstanceGetData, 'url'>;
3241
+ data: unknown;
3242
+ };
3243
+ POST_TASK_OUTPUT: {
3244
+ payload: Omit<UpdateTaskInstanceApiActivityTaskInstanceTaskInstanceIdPutData, 'url'>;
3245
+ data: unknown;
3246
+ };
3247
+ GET_DIMENSIONS: {
3248
+ payload: Omit<GetDimensionsApiAccountingDimensionGetData, 'url'>;
3249
+ data: GetDimensionsApiAccountingDimensionGetResponse;
3250
+ };
3251
+ GET_DIMENSION_VALUES: {
3252
+ payload: Omit<GetDimensionValuesApiAccountingDimensionValueGetData, 'url'>;
3253
+ data: GetDimensionValuesApiAccountingDimensionValueGetResponse;
3254
+ };
3255
+ GET_JOURNAL_ENTRIES: {
3256
+ payload: Omit<GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData, 'url'>;
3257
+ data: GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponse;
3258
+ };
3259
+ GET_ACTIVITY_DEFINITIONS: {
3260
+ payload: Omit<GetActivityDefinitionsApiActivityActivityDefinitionGetData, 'url'>;
3261
+ data: unknown;
3262
+ };
3263
+ GET_TASK_DEFINITIONS: {
3264
+ payload: Omit<GetAllTasksDefinitionsApiActivityTaskDefinitionGetData, 'url'>;
3265
+ data: GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponse;
3266
+ };
3267
+ GET_TASK_INSTANCES: {
3268
+ payload: Omit<GetAllTaskInstancesApiActivityTaskInstanceGetData, 'url'>;
3269
+ data: unknown;
3270
+ };
3271
+ GET_FISCAL_CALENDARS: {
3272
+ payload: Omit<GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetData, 'url'>;
3273
+ data: GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponse;
3274
+ };
3275
+ GET_FISCAL_CALENDAR: {
3276
+ payload: Omit<GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetData, 'url'>;
3277
+ data: GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse;
3278
+ };
3279
+ GET_ACCOUNTS: {
3280
+ payload: Omit<GetAccountsApiAccountingAccountGetData, 'url'>;
3281
+ data: GetAccountsApiAccountingAccountGetResponse;
3282
+ };
3283
+ GET_ACCOUNT: {
3284
+ payload: Omit<GetAccountApiAccountingAccountAccountIdGetData, 'url'>;
3285
+ data: GetAccountApiAccountingAccountAccountIdGetResponse;
3286
+ };
3287
+ GET_COA_TREE: {
3288
+ payload: Omit<GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetData, 'url'>;
3289
+ data: GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponse;
3290
+ };
3291
+ GET_COA_FLAT_SIMPLE: {
3292
+ payload: Omit<GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetData, 'url'>;
3293
+ data: GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponse;
3294
+ };
3295
+ GET_COA_GROUPED: {
3296
+ payload: Omit<GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetData, 'url'>;
3297
+ data: GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponse;
3298
+ };
3299
+ GET_COA_ACCOUNT: {
3300
+ payload: Omit<GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetData, 'url'>;
3301
+ data: GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponse;
3302
+ };
3303
+ GET_SUBSIDIARY_AVAILABLE_CURRENCIES: {
3304
+ payload: Omit<GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetData, 'url'>;
3305
+ data: GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponse;
3306
+ };
3307
+ GET_CONVERSION_RATES: {
3308
+ payload: Omit<GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetData, 'url'>;
3309
+ data: GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponse;
3310
+ };
3311
+ GET_EFFECTIVE_EXCHANGE_RATE: {
3312
+ payload: Omit<GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetData, 'url'>;
3313
+ data: GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponse;
3314
+ };
3315
+ GET_EXCHANGE_RATE_BY_DATE: {
3316
+ payload: Omit<GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetData, 'url'>;
3317
+ data: GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponse;
3318
+ };
3319
+ GET_DIMENSION_ACCOUNT_ASSIGNMENTS: {
3320
+ payload: Omit<GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetData, 'url'>;
3321
+ data: GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponse;
3322
+ };
3323
+ GET_DIMENSION_VALUES_HIERARCHICAL: {
3324
+ payload: Omit<GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetData, 'url'>;
3325
+ data: GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponse;
3326
+ };
3327
+ GET_JOURNAL_LINES: {
3328
+ payload: Omit<GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetData, 'url'>;
3329
+ data: GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponse;
3330
+ };
3331
+ GET_JOURNAL_ENTRY: {
3332
+ payload: Omit<GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetData, 'url'>;
3333
+ data: GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponse;
3334
+ };
3335
+ GET_PERIOD_INSTANCE: {
3336
+ payload: Omit<GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData, 'url'>;
3337
+ data: unknown;
3338
+ };
3339
+ GET_PERIOD_INSTANCE_BY_SLUG: {
3340
+ payload: Omit<GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData, 'url'>;
3341
+ data: unknown;
3342
+ };
3343
+ GET_PERIOD_PROGRESS_BREAKDOWN: {
3344
+ payload: Omit<GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetData, 'url'>;
3345
+ data: GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponse;
3346
+ };
3347
+ GET_ACTIVITY_DEFINITION: {
3348
+ payload: Omit<GetActivityDefinitionByIdApiActivityActivityDefinitionActivityDefinitionIdGetData, 'url'>;
3349
+ data: unknown;
3350
+ };
3351
+ GET_ACTIVITY_INSTANCES: {
3352
+ payload: Omit<GetActivityInstancesApiActivityActivityInstanceGetData, 'url'>;
3353
+ data: GetActivityInstancesApiActivityActivityInstanceGetResponse;
3354
+ };
3355
+ GET_ACTIVITY_INSTANCE: {
3356
+ payload: Omit<GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData, 'url'>;
3357
+ data: unknown;
3358
+ };
3359
+ GET_ACTIVITY_INSTANCE_BY_PERIOD: {
3360
+ payload: Omit<GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetData, 'url'>;
3361
+ data: GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponse;
3362
+ };
3363
+ GET_ACTIVITY_INSTANCE_TASKS: {
3364
+ payload: Omit<GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTaskGetData, 'url'>;
3365
+ data: unknown;
3366
+ };
3367
+ GET_ACTIVITY_PERIOD_TASKS: {
3368
+ payload: Omit<GetTaskInstancesByActivityPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdTaskGetData, 'url'>;
3369
+ data: unknown;
3370
+ };
3371
+ GET_TASK_DEFINITION: {
3372
+ payload: Omit<GetTaskDefinitionByIdApiActivityTaskDefinitionTaskDefinitionIdGetData, 'url'>;
3373
+ data: unknown;
3374
+ };
3375
+ CREATE_TASK_DEFINITION: {
3376
+ payload: Omit<CreateTaskDefinitionApiActivityTaskDefinitionPostData, 'url'>;
3377
+ data: CreateTaskDefinitionApiActivityTaskDefinitionPostResponse;
3378
+ };
3379
+ UPDATE_TASK_DEFINITION: {
3380
+ payload: Omit<UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutData, 'url'>;
3381
+ data: UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponse;
3382
+ };
3383
+ GET_TASK_DEFINITIONS_BY_FILTER: {
3384
+ payload: Omit<GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData, 'url'>;
3385
+ data: GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponse;
3386
+ };
3387
+ GET_TASK_INSTANCE: {
3388
+ payload: Omit<GetTaskInstanceByIdApiActivityTaskInstanceTaskInstanceIdGetData, 'url'>;
3389
+ data: unknown;
3390
+ };
3391
+ GET_TASK_INSTANCES_BY_FILTER: {
3392
+ payload: Omit<GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostData, 'url'>;
3393
+ data: GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponse;
3394
+ };
3395
+ GET_AUDIT_EVENTS: {
3396
+ payload: Omit<GetEventsApiAuditTrailEventGetData, 'url'>;
3397
+ data: GetEventsApiAuditTrailEventGetResponse;
3398
+ };
3399
+ GET_ENTITY_AUDIT_EVENTS: {
3400
+ payload: Omit<GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostData, 'url'>;
3401
+ data: GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponse;
3402
+ };
3403
+ GET_SUBSIDIARY: {
3404
+ payload: Omit<GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData, 'url'>;
3405
+ data: GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponse;
3406
+ };
3407
+ GET_SUBSIDIARY_PARENT_CURRENCIES: {
3408
+ payload: Omit<GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetData, 'url'>;
3409
+ data: GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponse;
3410
+ };
3411
+ GET_TENANT_USERS: {
3412
+ payload: Omit<GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData, 'url'>;
3413
+ data: GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponse;
3414
+ };
3415
+ GET_CONTEXT: {
3416
+ payload: GetContextPayload;
3417
+ data: ContextPayload;
3418
+ };
3419
+ UPLOAD_FILE: {
3420
+ payload: UploadPayload;
3421
+ data: UploadResponse;
3422
+ progress: UploadProgress;
3423
+ };
3424
+ }
3425
+
3426
+ interface VibeAppBridgeOptions {
3427
+ parentOrigin: string;
3428
+ requestTimeout?: number;
3429
+ }
3430
+ interface UploadOptions {
3431
+ entityType: string;
3432
+ entityId?: string | number;
3433
+ onProgress?: (p: RequestRegistry['UPLOAD_FILE']['progress']) => void;
3434
+ }
3435
+ declare class VibeAppBridge {
3436
+ private readonly parentOrigin;
3437
+ private readonly requestTimeout;
3438
+ private readonly pendingRequests;
3439
+ private readonly boundHandleMessage;
3440
+ private context;
3441
+ private connectPromise;
3442
+ private connectPollInterval;
3443
+ private onContextReceived;
3444
+ private lastReportedSubroute;
3445
+ private suppressSubrouteReport;
3446
+ private subrouteCallback;
3447
+ private origPushState;
3448
+ private origReplaceState;
3449
+ private popstateHandler;
3450
+ private readonly kindHandlers;
3451
+ private dispatchPush;
3452
+ private readonly pushHandlers;
3453
+ constructor({ parentOrigin, requestTimeout }: VibeAppBridgeOptions);
3454
+ /**
3455
+ * Connects to the host and returns the tenant/user context.
3456
+ * Call once on app init — concurrent calls return the same promise.
3457
+ *
3458
+ * Actively polls the host every 500ms until a response arrives, which
3459
+ * handles the race condition where the host's initial context push arrives
3460
+ * before this listener is ready.
3461
+ *
3462
+ * After connecting, if the context includes an initial subroute (e.g. from
3463
+ * a deep link), the bridge navigates to it and starts auto-tracking
3464
+ * internal navigation via the history API.
3465
+ */
3466
+ connect(): Promise<ContextPayload>;
3467
+ getChartOfAccounts(payload: RequestRegistry['GET_CHART_OF_ACCOUNTS']['payload']): Promise<RequestRegistry['GET_CHART_OF_ACCOUNTS']['data']>;
3468
+ getSubsidiaries(payload: RequestRegistry['GET_SUBSIDIARIES']['payload']): Promise<RequestRegistry['GET_SUBSIDIARIES']['data']>;
3469
+ getPeriods(payload: RequestRegistry['GET_PERIODS']['payload']): Promise<RequestRegistry['GET_PERIODS']['data']>;
3470
+ postTaskOutput(payload: RequestRegistry['POST_TASK_OUTPUT']['payload']): Promise<RequestRegistry['POST_TASK_OUTPUT']['data']>;
3471
+ getJournalEntries(payload: RequestRegistry['GET_JOURNAL_ENTRIES']['payload']): Promise<RequestRegistry['GET_JOURNAL_ENTRIES']['data']>;
3472
+ getJournalLines(payload: RequestRegistry['GET_JOURNAL_LINES']['payload']): Promise<RequestRegistry['GET_JOURNAL_LINES']['data']>;
3473
+ /**
3474
+ * Uploads a file through the host. Converts the File to an ArrayBuffer
3475
+ * before sending — sandboxed iframes cannot pass File handles across windows.
3476
+ */
3477
+ upload(file: File, options: UploadOptions): Promise<RequestRegistry['UPLOAD_FILE']['data']>;
3478
+ /**
3479
+ * Manually reports the current subroute to the host.
3480
+ * Usually not needed — navigation is auto-detected via the history API.
3481
+ * Use this for hash-based routers or non-standard navigation patterns.
3482
+ */
3483
+ reportSubroute(subroute: string, options?: {
3484
+ replace?: boolean;
3485
+ }): void;
3486
+ /**
3487
+ * Registers a callback for host-initiated navigation (browser back/forward).
3488
+ * If no callback is registered, the SDK uses `history.pushState` + a
3489
+ * `popstate` event, which works for most SPA routers automatically.
3490
+ * Returns an unsubscribe function.
3491
+ */
3492
+ onSubrouteRequest(callback: (subroute: string) => void): () => void;
3493
+ destroy(): void;
3494
+ private stopConnectPolling;
3495
+ /**
3496
+ * Monkey-patches `history.pushState` and `history.replaceState` to
3497
+ * auto-detect SPA navigation and report it to the host. Called after
3498
+ * connect() resolves.
3499
+ */
3500
+ private setupNavigationTracking;
3501
+ private teardownNavigationTracking;
3502
+ /** Runs `fn` while suppressing subroute auto-reporting to prevent echo loops. */
3503
+ private withSubrouteSuppressed;
3504
+ private reportCurrentSubroute;
3505
+ private sendCommand;
3506
+ request<K extends keyof RequestRegistry>(type: K, payload: RequestRegistry[K]['payload'], onProgress?: (payload: unknown) => void): Promise<RequestRegistry[K]['data']>;
3507
+ private handleMessage;
3508
+ private handleResponse;
3509
+ private handleProgress;
3510
+ }
3511
+
3512
+ export { version as BRIDGE_VERSION, VibeAppBridge, type VibeAppBridgeOptions };