@nominalso/vibe-bridge 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,3769 +1,20 @@
1
- var version = "0.5.0";
1
+ import { B as BridgeDataMethods, V as VibeAppBridgeOptions, C as ContextPayload, A as AuthPayload, N as NavigateAction, S as SetSideNavPayload, I as InvalidateCachePayload, a as InvalidateResult, R as RequestRegistry } from './version-Cufn3-b0.js';
2
+ export { b as BRIDGE_VERSION, c as BridgeError, d as BridgeSubsidiary, H as HttpBridgeError, P as PostHogContext, U as UploadOptions, e as UploadProgress, f as UploadResponse } from './version-Cufn3-b0.js';
2
3
 
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
- currency?: ActivityCurrency | null;
1396
- side_a_entity_type: ActivityReconciliationEntityType;
1397
- side_a_entity_id: string;
1398
- side_b_entity_type: ActivityReconciliationEntityType;
1399
- side_b_entity_id?: string | null;
1400
- side_a_source: ActivityReconciliationSource;
1401
- side_b_source: ActivityReconciliationSource;
1402
- };
1403
- type ActivityReconciliationEntityType = 'account' | 'bank_account' | 'external_balance_capture';
1404
- type ActivityReconciliationInstanceDataInput = {
1405
- reconciliation_definition_id: string;
1406
- task_instance_id: string;
1407
- start_date: string;
1408
- end_date: string;
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
- side_a_value?: string | null;
1423
- side_b_value?: string | null;
1424
- reconciling_items_balance?: string | null;
1425
- variance?: string | null;
1426
- variance_percentage?: string | null;
1427
- has_post_signoff_changes?: boolean;
1428
- event_timestamp?: string | null;
1429
- };
1430
- type ActivityReconciliationSource = 'gl' | 'bank' | 'external';
1431
- type ActivityReconciliationStatus = 'PENDING' | 'IN_PROGRESS' | 'DONE' | 'FAILED';
1432
- type ActivityReconciliationSubmitActionTemplate = {
1433
- action_type?: 'reconciliation_submit';
1434
- reconciliation_definition_id: string;
1435
- };
1436
- type ActivityReconciliationSubmitTaskActionDataInput = {
1437
- action_type?: 'reconciliation_submit';
1438
- reconciliation_definition_id: string;
1439
- reconciliation_definition: ActivityReconciliationDefinitionData;
1440
- reconciliation_instance_id?: string | null;
1441
- reconciliation_instance?: ActivityReconciliationInstanceDataInput | null;
1442
- };
1443
- type ActivityReconciliationSubmitTaskActionDataOutput = {
1444
- action_type?: 'reconciliation_submit';
1445
- reconciliation_definition_id: string;
1446
- reconciliation_definition: ActivityReconciliationDefinitionData;
1447
- reconciliation_instance_id?: string | null;
1448
- reconciliation_instance?: ActivityReconciliationInstanceDataOutput | null;
1449
- };
1450
- type ActivityReconciliationType = 'bank_reconciliation' | 'account_reconciliation';
1451
- type ActivitySlimTaskAction = {
1452
- created_at?: string | null;
1453
- last_modified_at?: string | null;
1454
- id?: string;
1455
- task_instance_id: string;
1456
- status: ActivityTaskActionStatus;
1457
- execution_start_time?: string | null;
1458
- };
1459
- type ActivitySlimTaskDefinitionWithInstances = {
1460
- name: string;
1461
- due_date: ActivityTaskDueDate;
1462
- preparer_due_date?: ActivityDueDate | null;
1463
- description?: string | null;
1464
- preparer_id?: string | null;
1465
- assignee_id?: string | null;
1466
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
1467
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1468
- end_date?: string | null;
1469
- task_type?: ActivityTaskType | null;
1470
- created_at?: string | null;
1471
- last_modified_at?: string | null;
1472
- is_deleted?: boolean;
1473
- activity_definition_id: string;
1474
- start_date: string;
1475
- subsidiary_ids: Array<number>;
1476
- activity_instance_id?: string | null;
1477
- recurring: boolean;
1478
- id?: string;
1479
- creator_user_id?: string | null;
1480
- is_manual_task?: boolean;
1481
- entities?: Array<ActivityTaskEntityMapping>;
1482
- action_template?: (({
1483
- action_type?: 'create_journal_entry';
1484
- } & ActivityCreateJournalEntryActionTemplateOutput) | ({
1485
- action_type?: 'create_ict_elimination_entries';
1486
- } & ActivityCreateIctEliminationActionTemplateOutput) | ({
1487
- action_type?: 'post_ict';
1488
- } & ActivityPostIctActionTemplate) | ({
1489
- action_type?: 'test_action';
1490
- } & ActivityTestActionTemplate) | ({
1491
- action_type?: 'test_schedule_action';
1492
- } & ActivityTestScheduleActionTemplate) | ({
1493
- action_type?: 'lease_payment';
1494
- } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1495
- action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1496
- } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1497
- action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1498
- } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1499
- action_type?: 'lease_term_reminder';
1500
- } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1501
- action_type?: 'create_journal_entry_schedule';
1502
- } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1503
- action_type?: 'create_journal_entries';
1504
- } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
1505
- action_type?: 'failure_task';
1506
- } & ActivityFailureActionTemplate) | ({
1507
- action_type?: 'lock_consolidation_period';
1508
- } & ActivityLockConsolidationRateActionTemplate) | ({
1509
- action_type?: 'create_journal_entries_bulk';
1510
- } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
1511
- action_type?: 'match_resolution';
1512
- } & ActivityMatchResolutionActionTemplate) | ({
1513
- action_type?: 'reconciliation_submit';
1514
- } & ActivityReconciliationSubmitActionTemplate)) | null;
1515
- reconciliation_definition_params?: ({
1516
- reconciliation_type?: 'account_reconciliation';
1517
- } & ActivityAccountReconciliationParams) | null;
1518
- trigger_id?: string | null;
1519
- workflow_execution_id?: string | null;
1520
- creator_task_id?: string | null;
1521
- activity_definition: ActivityActivityDefinitionCreateWithType;
1522
- action_type?: string | null;
1523
- task_instances?: Array<ActivityBaseTaskInstanceWithAction>;
1524
- creator: ActivityTaskCreator | null;
1525
- };
1526
- type ActivitySlimTaskInstanceWithAction = {
1527
- last_manually_updated?: string | null;
1528
- created_at?: string | null;
1529
- last_modified_at?: string | null;
1530
- id: string;
1531
- name: string;
1532
- due_date: string;
1533
- preparer_due_date: string;
1534
- status: ActivityTaskStatus;
1535
- description?: string | null;
1536
- task_definition_id: string;
1537
- activity_instance_id: string;
1538
- subsidiary_id: number;
1539
- is_deleted?: boolean;
1540
- preparer_id?: string | null;
1541
- assignee_id?: string | null;
1542
- reconciled?: boolean | null;
1543
- creator?: ActivityTaskCreator | null;
1544
- decline_reason?: string | null;
1545
- trigger_execution_id?: string | null;
1546
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
1547
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1548
- is_currently_blocked?: boolean | null;
1549
- is_blocking_manually_set?: boolean;
1550
- task_type?: ActivityTaskType | null;
1551
- attachments_count?: number;
1552
- task_action?: ActivitySlimTaskAction | null;
1553
- task_action_type?: string | null;
1554
- is_manual_task?: boolean | null;
1555
- activity_name?: string | null;
1556
- period_display_id?: string | null;
1557
- activity_definition_id?: string | null;
1558
- };
1559
- type ActivitySlimTaskInstanceWithActionAndEntities = {
1560
- last_manually_updated?: string | null;
1561
- created_at?: string | null;
1562
- last_modified_at?: string | null;
1563
- id: string;
1564
- name: string;
1565
- due_date: string;
1566
- preparer_due_date: string;
1567
- status: ActivityTaskStatus;
1568
- description?: string | null;
1569
- task_definition_id: string;
1570
- activity_instance_id: string;
1571
- subsidiary_id: number;
1572
- is_deleted?: boolean;
1573
- preparer_id?: string | null;
1574
- assignee_id?: string | null;
1575
- reconciled?: boolean | null;
1576
- creator?: ActivityTaskCreator | null;
1577
- decline_reason?: string | null;
1578
- trigger_execution_id?: string | null;
1579
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
1580
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1581
- is_currently_blocked?: boolean | null;
1582
- is_blocking_manually_set?: boolean;
1583
- task_type?: ActivityTaskType | null;
1584
- attachments_count?: number;
1585
- task_action?: ActivitySlimTaskAction | null;
1586
- task_action_type?: string | null;
1587
- is_manual_task?: boolean | null;
1588
- activity_name?: string | null;
1589
- period_display_id?: string | null;
1590
- activity_definition_id?: string | null;
1591
- task_definition_entities?: Array<ActivityTaskEntityMapping> | null;
1592
- };
1593
- type ActivitySortableFieldsTask = 'due_date' | 'name' | 'subsidiary_id' | 'status' | 'preparer_id' | 'assignee_id' | 'activity_name' | 'closing_period';
1594
- type ActivitySortingOrder = 'asc' | 'desc';
1595
- type ActivitySubLedger = 'lease' | 'prepaid_expense';
1596
- /**
1597
- * Progress for a subsidiary within an activity.
1598
- */
1599
- type ActivitySubsidiaryProgress = {
1600
- subsidiary_id: number;
1601
- progress: ActivityTasksProgress;
1602
- };
1603
- type ActivityTAccountWithoutSubsidiaryMappingInput = {
1604
- id: string;
1605
- name: string;
1606
- report_category?: ActivityAccountReportCategory | null;
1607
- accounting_class: ActivityAccountingClass;
1608
- account_type: ActivityAccountType;
1609
- account_rate_type?: ActivityConsolidationExchangeRateType | null;
1610
- account_number?: string | null;
1611
- parent_account_id?: string | null;
1612
- active?: boolean;
1613
- summary?: boolean;
1614
- read_only?: boolean;
1615
- is_manually_created?: boolean;
1616
- provider_id: string;
1617
- subsidiary_id: number;
1618
- currency?: ActivityCurrency;
1619
- sourced_account_id?: string | null;
1620
- account_balance?: ActivityBalanceInput;
1621
- primary_balance?: ActivityBalanceInput;
1622
- secondary_balance?: ActivityBalanceInput;
1623
- cta_balance?: ActivityBalanceInput;
1624
- credit_account_balance?: ActivityBalanceInput;
1625
- debit_account_balance?: ActivityBalanceInput;
1626
- credit_primary_balance?: ActivityBalanceInput;
1627
- debit_primary_balance?: ActivityBalanceInput;
1628
- credit_secondary_balance?: ActivityBalanceInput;
1629
- debit_secondary_balance?: ActivityBalanceInput;
1630
- credit_cta_balance?: ActivityBalanceInput;
1631
- debit_cta_balance?: ActivityBalanceInput;
1632
- tertiary_debit?: ActivityBalanceInput | null;
1633
- tertiary_credit?: ActivityBalanceInput | null;
1634
- create_time?: string;
1635
- last_update_time?: string;
1636
- description?: string | null;
1637
- meta?: {
1638
- [key: string]: unknown;
1639
- } | null;
1640
- nominal_account?: ActivityMappedNominalAccount | null;
1641
- };
1642
- type ActivityTAccountWithoutSubsidiaryMappingOutput = {
1643
- id: string;
1644
- name: string;
1645
- report_category?: ActivityAccountReportCategory | null;
1646
- accounting_class: ActivityAccountingClass;
1647
- account_type: ActivityAccountType;
1648
- account_rate_type?: ActivityConsolidationExchangeRateType | null;
1649
- account_number?: string | null;
1650
- parent_account_id?: string | null;
1651
- active?: boolean;
1652
- summary?: boolean;
1653
- read_only?: boolean;
1654
- is_manually_created?: boolean;
1655
- provider_id: string;
1656
- subsidiary_id: number;
1657
- currency?: ActivityCurrency;
1658
- sourced_account_id?: string | null;
1659
- account_balance?: ActivityBalanceOutput;
1660
- primary_balance?: ActivityBalanceOutput;
1661
- secondary_balance?: ActivityBalanceOutput;
1662
- cta_balance?: ActivityBalanceOutput;
1663
- credit_account_balance?: ActivityBalanceOutput;
1664
- debit_account_balance?: ActivityBalanceOutput;
1665
- credit_primary_balance?: ActivityBalanceOutput;
1666
- debit_primary_balance?: ActivityBalanceOutput;
1667
- credit_secondary_balance?: ActivityBalanceOutput;
1668
- debit_secondary_balance?: ActivityBalanceOutput;
1669
- credit_cta_balance?: ActivityBalanceOutput;
1670
- debit_cta_balance?: ActivityBalanceOutput;
1671
- tertiary_debit?: ActivityBalanceOutput | null;
1672
- tertiary_credit?: ActivityBalanceOutput | null;
1673
- create_time?: string;
1674
- last_update_time?: string;
1675
- description?: string | null;
1676
- meta?: {
1677
- [key: string]: unknown;
1678
- } | null;
1679
- nominal_account?: ActivityMappedNominalAccount | null;
1680
- };
1681
- type ActivityTaskActionInput = {
1682
- created_at?: string | null;
1683
- last_modified_at?: string | null;
1684
- id?: string;
1685
- task_instance_id: string;
1686
- status: ActivityTaskActionStatus;
1687
- execution_start_time?: string | null;
1688
- action_data: ({
1689
- action_type?: 'create_journal_entry';
1690
- } & ActivityCreateJournalEntryTaskActionDataInput) | ({
1691
- action_type?: 'create_ict_elimination_entries';
1692
- } & ActivityCreateIctEliminationTaskActionDataInput) | ({
1693
- action_type?: 'test_action';
1694
- } & ActivityTestActionData) | ({
1695
- action_type?: 'create_bill';
1696
- } & ActivityCreateBillTaskActionDataInput) | ({
1697
- action_type?: 'post_bill';
1698
- } & ActivityPostBillTaskActionDataInput) | ({
1699
- action_type?: 'post_journal_entry';
1700
- } & ActivityPostJournalEntryTaskActionDataInput) | ({
1701
- action_type?: 'post_ict';
1702
- } & ActivityPostIctTaskActionData) | ({
1703
- action_type?: 'create_journal_entry_schedule';
1704
- } & ActivityCreateJournalEntryTaskScheduleActionDataInput) | ({
1705
- action_type?: 'failure_task';
1706
- } & ActivityFailureTaskActionData) | ({
1707
- action_type?: 'lock_consolidation_period';
1708
- } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1709
- action_type?: 'create_journal_entries_bulk';
1710
- } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1711
- action_type?: 'match_resolution';
1712
- } & ActivityMatchResolutionTaskActionData) | ({
1713
- action_type?: 'reconciliation_submit';
1714
- } & ActivityReconciliationSubmitTaskActionDataInput);
1715
- original_action_data?: (({
1716
- action_type?: 'create_journal_entry';
1717
- } & ActivityCreateJournalEntryTaskActionDataInput) | ({
1718
- action_type?: 'create_ict_elimination_entries';
1719
- } & ActivityCreateIctEliminationTaskActionDataInput) | ({
1720
- action_type?: 'test_action';
1721
- } & ActivityTestActionData) | ({
1722
- action_type?: 'create_bill';
1723
- } & ActivityCreateBillTaskActionDataInput) | ({
1724
- action_type?: 'post_bill';
1725
- } & ActivityPostBillTaskActionDataInput) | ({
1726
- action_type?: 'post_journal_entry';
1727
- } & ActivityPostJournalEntryTaskActionDataInput) | ({
1728
- action_type?: 'post_ict';
1729
- } & ActivityPostIctTaskActionData) | ({
1730
- action_type?: 'create_journal_entry_schedule';
1731
- } & ActivityCreateJournalEntryTaskScheduleActionDataInput) | ({
1732
- action_type?: 'failure_task';
1733
- } & ActivityFailureTaskActionData) | ({
1734
- action_type?: 'lock_consolidation_period';
1735
- } & ActivityCreateLockPeriodTaskActionDataInput) | ({
1736
- action_type?: 'create_journal_entries_bulk';
1737
- } & ActivityCreateJournalEntriesBulkTaskActionDataInput) | ({
1738
- action_type?: 'match_resolution';
1739
- } & ActivityMatchResolutionTaskActionData) | ({
1740
- action_type?: 'reconciliation_submit';
1741
- } & ActivityReconciliationSubmitTaskActionDataInput)) | null;
1742
- execution_errors?: Array<ActivityTaskActionExecutionError> | null;
1743
- };
1744
- type ActivityTaskActionOutput = {
1745
- created_at?: string | null;
1746
- last_modified_at?: string | null;
1747
- id?: string;
1748
- task_instance_id: string;
1749
- status: ActivityTaskActionStatus;
1750
- execution_start_time?: string | null;
1751
- action_data: ({
1752
- action_type?: 'create_journal_entry';
1753
- } & ActivityCreateJournalEntryTaskActionDataOutput) | ({
1754
- action_type?: 'create_ict_elimination_entries';
1755
- } & ActivityCreateIctEliminationTaskActionDataOutput) | ({
1756
- action_type?: 'test_action';
1757
- } & ActivityTestActionData) | ({
1758
- action_type?: 'create_bill';
1759
- } & ActivityCreateBillTaskActionDataOutput) | ({
1760
- action_type?: 'post_bill';
1761
- } & ActivityPostBillTaskActionDataOutput) | ({
1762
- action_type?: 'post_journal_entry';
1763
- } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1764
- action_type?: 'post_ict';
1765
- } & ActivityPostIctTaskActionData) | ({
1766
- action_type?: 'create_journal_entry_schedule';
1767
- } & ActivityCreateJournalEntryTaskScheduleActionDataOutput) | ({
1768
- action_type?: 'failure_task';
1769
- } & ActivityFailureTaskActionData) | ({
1770
- action_type?: 'lock_consolidation_period';
1771
- } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1772
- action_type?: 'create_journal_entries_bulk';
1773
- } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1774
- action_type?: 'match_resolution';
1775
- } & ActivityMatchResolutionTaskActionData) | ({
1776
- action_type?: 'reconciliation_submit';
1777
- } & ActivityReconciliationSubmitTaskActionDataOutput);
1778
- original_action_data?: (({
1779
- action_type?: 'create_journal_entry';
1780
- } & ActivityCreateJournalEntryTaskActionDataOutput) | ({
1781
- action_type?: 'create_ict_elimination_entries';
1782
- } & ActivityCreateIctEliminationTaskActionDataOutput) | ({
1783
- action_type?: 'test_action';
1784
- } & ActivityTestActionData) | ({
1785
- action_type?: 'create_bill';
1786
- } & ActivityCreateBillTaskActionDataOutput) | ({
1787
- action_type?: 'post_bill';
1788
- } & ActivityPostBillTaskActionDataOutput) | ({
1789
- action_type?: 'post_journal_entry';
1790
- } & ActivityPostJournalEntryTaskActionDataOutput) | ({
1791
- action_type?: 'post_ict';
1792
- } & ActivityPostIctTaskActionData) | ({
1793
- action_type?: 'create_journal_entry_schedule';
1794
- } & ActivityCreateJournalEntryTaskScheduleActionDataOutput) | ({
1795
- action_type?: 'failure_task';
1796
- } & ActivityFailureTaskActionData) | ({
1797
- action_type?: 'lock_consolidation_period';
1798
- } & ActivityCreateLockPeriodTaskActionDataOutput) | ({
1799
- action_type?: 'create_journal_entries_bulk';
1800
- } & ActivityCreateJournalEntriesBulkTaskActionDataOutput) | ({
1801
- action_type?: 'match_resolution';
1802
- } & ActivityMatchResolutionTaskActionData) | ({
1803
- action_type?: 'reconciliation_submit';
1804
- } & ActivityReconciliationSubmitTaskActionDataOutput)) | null;
1805
- execution_errors?: Array<ActivityTaskActionExecutionError> | null;
1806
- };
1807
- type ActivityTaskActionExecutionError = {
1808
- error_type: ActivityTaskActionExecutionErrorType;
1809
- error_message: string;
1810
- error_summary?: string | null;
1811
- error_time?: string;
1812
- required_action?: string | null;
1813
- subsidiary_id?: number | null;
1814
- };
1815
- type ActivityTaskActionExecutionErrorType = 'Server Error' | 'Provider Validation Error' | 'Provider Connection Error' | 'Provider Authentication Error';
1816
- type ActivityTaskActionStatus = 'DONE' | 'PENDING' | 'CANCELLED' | 'FAILED' | 'IN_PROGRESS' | 'RESETTING';
1817
- /**
1818
- * Represents a blocking relationship for a definition or instance.
1819
- */
1820
- type ActivityTaskBlocking = {
1821
- id: string;
1822
- scope: ActivityBlockingScope;
1823
- };
1824
- type ActivityTaskCreator = {
1825
- type?: ActivityTaskCreatorType | null;
1826
- entity_type?: ActivityTaskEntityType | null;
1827
- id?: string | null;
1828
- };
1829
- type ActivityTaskCreatorType = 'user' | 'trigger' | 'workflow_execution' | 'task' | 'entity';
1830
- type ActivityTaskDefinition = {
1831
- name: string;
1832
- due_date: ActivityTaskDueDate;
1833
- preparer_due_date?: ActivityDueDate | null;
1834
- description?: string | null;
1835
- preparer_id?: string | null;
1836
- assignee_id?: string | null;
1837
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
1838
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1839
- end_date?: string | null;
1840
- task_type?: ActivityTaskType | null;
1841
- created_at?: string | null;
1842
- last_modified_at?: string | null;
1843
- is_deleted?: boolean;
1844
- activity_definition_id: string;
1845
- start_date: string;
1846
- subsidiary_ids: Array<number>;
1847
- activity_instance_id?: string | null;
1848
- recurring: boolean;
1849
- id?: string;
1850
- creator_user_id?: string | null;
1851
- is_manual_task?: boolean;
1852
- entities?: Array<ActivityTaskEntityMapping>;
1853
- action_template?: (({
1854
- action_type?: 'create_journal_entry';
1855
- } & ActivityCreateJournalEntryActionTemplateOutput) | ({
1856
- action_type?: 'create_ict_elimination_entries';
1857
- } & ActivityCreateIctEliminationActionTemplateOutput) | ({
1858
- action_type?: 'post_ict';
1859
- } & ActivityPostIctActionTemplate) | ({
1860
- action_type?: 'test_action';
1861
- } & ActivityTestActionTemplate) | ({
1862
- action_type?: 'test_schedule_action';
1863
- } & ActivityTestScheduleActionTemplate) | ({
1864
- action_type?: 'lease_payment';
1865
- } & ActivityLeasePaymentScheduleActionTemplateOutput) | ({
1866
- action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1867
- } & ActivityLeaseAmortizationScheduleActionTemplateOutput) | ({
1868
- action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1869
- } & ActivityLeaseAmortizationOpeningBalanceActionTemplateOutput) | ({
1870
- action_type?: 'lease_term_reminder';
1871
- } & ActivityLeaseTermReminderActionTemplateOutput) | ({
1872
- action_type?: 'create_journal_entry_schedule';
1873
- } & ActivityCreateJournalEntryScheduleActionTemplateOutput) | ({
1874
- action_type?: 'create_journal_entries';
1875
- } & ActivityCreateJournalEntriesActionTemplateOutput) | ({
1876
- action_type?: 'failure_task';
1877
- } & ActivityFailureActionTemplate) | ({
1878
- action_type?: 'lock_consolidation_period';
1879
- } & ActivityLockConsolidationRateActionTemplate) | ({
1880
- action_type?: 'create_journal_entries_bulk';
1881
- } & ActivityCreateJournalEntriesBulkActionTemplateOutput) | ({
1882
- action_type?: 'match_resolution';
1883
- } & ActivityMatchResolutionActionTemplate) | ({
1884
- action_type?: 'reconciliation_submit';
1885
- } & ActivityReconciliationSubmitActionTemplate)) | null;
1886
- reconciliation_definition_params?: ({
1887
- reconciliation_type?: 'account_reconciliation';
1888
- } & ActivityAccountReconciliationParams) | null;
1889
- trigger_id?: string | null;
1890
- workflow_execution_id?: string | null;
1891
- creator_task_id?: string | null;
1892
- activity_definition: ActivityActivityDefinitionCreateWithType;
1893
- action_type?: string | null;
1894
- creator: ActivityTaskCreator | null;
1895
- };
1896
- type ActivityTaskDefinitionUpdate = {
1897
- name: string;
1898
- due_date: ActivityTaskDueDate;
1899
- preparer_due_date?: ActivityDueDate | null;
1900
- description?: string | null;
1901
- preparer_id?: string | null;
1902
- assignee_id?: string | null;
1903
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
1904
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1905
- end_date?: string | null;
1906
- task_type?: ActivityTaskType | null;
1907
- created_at?: string | null;
1908
- last_modified_at?: string | null;
1909
- is_deleted?: boolean;
1910
- activity_definition_id: string;
1911
- start_date: string;
1912
- subsidiary_ids: Array<number>;
1913
- activity_instance_id?: string | null;
1914
- recurring: boolean;
1915
- };
1916
- type ActivityTaskDefinitionWithActionCreateApi = {
1917
- name: string;
1918
- due_date: ActivityTaskDueDate;
1919
- preparer_due_date?: ActivityDueDate | null;
1920
- description?: string | null;
1921
- preparer_id?: string | null;
1922
- assignee_id?: string | null;
1923
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
1924
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
1925
- end_date?: string | null;
1926
- task_type?: ActivityTaskType | null;
1927
- created_at?: string | null;
1928
- last_modified_at?: string | null;
1929
- is_deleted?: boolean;
1930
- activity_definition_id: string;
1931
- start_date: string;
1932
- subsidiary_ids: Array<number>;
1933
- activity_instance_id?: string | null;
1934
- recurring: boolean;
1935
- id?: string;
1936
- creator_user_id?: string | null;
1937
- is_manual_task?: boolean;
1938
- entities?: Array<ActivityTaskEntityMappingCreate>;
1939
- action_template?: (({
1940
- action_type?: 'create_journal_entry';
1941
- } & ActivityCreateJournalEntryActionTemplateInput) | ({
1942
- action_type?: 'create_ict_elimination_entries';
1943
- } & ActivityCreateIctEliminationActionTemplateInput) | ({
1944
- action_type?: 'post_ict';
1945
- } & ActivityPostIctActionTemplate) | ({
1946
- action_type?: 'test_action';
1947
- } & ActivityTestActionTemplate) | ({
1948
- action_type?: 'test_schedule_action';
1949
- } & ActivityTestScheduleActionTemplate) | ({
1950
- action_type?: 'lease_payment';
1951
- } & ActivityLeasePaymentScheduleActionTemplateInput) | ({
1952
- action_type?: 'LEASE_AMORTIZATION_SCHEDULE';
1953
- } & ActivityLeaseAmortizationScheduleActionTemplateInput) | ({
1954
- action_type?: 'LEASE_AMORTIZATION_OPENING_BALANCE';
1955
- } & ActivityLeaseAmortizationOpeningBalanceActionTemplateInput) | ({
1956
- action_type?: 'lease_term_reminder';
1957
- } & ActivityLeaseTermReminderActionTemplateInput) | ({
1958
- action_type?: 'create_journal_entry_schedule';
1959
- } & ActivityCreateJournalEntryScheduleActionTemplateInput) | ({
1960
- action_type?: 'create_journal_entries';
1961
- } & ActivityCreateJournalEntriesActionTemplateInput) | ({
1962
- action_type?: 'failure_task';
1963
- } & ActivityFailureActionTemplate) | ({
1964
- action_type?: 'lock_consolidation_period';
1965
- } & ActivityLockConsolidationRateActionTemplate) | ({
1966
- action_type?: 'create_journal_entries_bulk';
1967
- } & ActivityCreateJournalEntriesBulkActionTemplateInput) | ({
1968
- action_type?: 'match_resolution';
1969
- } & ActivityMatchResolutionActionTemplate) | ({
1970
- action_type?: 'reconciliation_submit';
1971
- } & ActivityReconciliationSubmitActionTemplate)) | null;
1972
- reconciliation_definition_params?: ({
1973
- reconciliation_type?: 'account_reconciliation';
1974
- } & ActivityAccountReconciliationParams) | null;
1975
- };
1976
- /**
1977
- * Task-specific DueDate that carries an optional preparer/reviewer offset.
1978
- *
1979
- * Stored in task_definition.due_date JSONB. Not added to the shared libcommon
1980
- * DueDate. No min/max on offset: range is enforced in the FE so the BE can stay
1981
- * reusable if product changes the bounds (0 means preparer == reviewer).
1982
- */
1983
- type ActivityTaskDueDate = {
1984
- from_start: boolean;
1985
- days_delta: number;
1986
- is_forward: boolean;
1987
- delta_unit?: ActivityDeltaUnit;
1988
- is_specific_day?: boolean;
1989
- should_skip_holidays?: boolean;
1990
- offset?: number | null;
1991
- };
1992
- /**
1993
- * Model representing an entity mapping for a task definition.
1994
- */
1995
- type ActivityTaskEntityMapping = {
1996
- entity_id: string;
1997
- entity_type: ActivityTaskEntityType;
1998
- task_definition_id: string;
1999
- };
2000
- /**
2001
- * Model representing an entity mapping for a task definition.
2002
- */
2003
- type ActivityTaskEntityMappingCreate = {
2004
- entity_id: string;
2005
- entity_type: ActivityTaskEntityType;
2006
- };
2007
- type ActivityTaskEntityType = 'lease' | 'transaction' | 'clearing_group' | 'journal_entry' | 'invoice' | 'workflow_output' | 'attachment' | 'match' | 'reconciliation';
2008
- type ActivityTaskInstancePaginationOutput = {
2009
- results?: Array<ActivityTaskInstanceWithActivity | ActivitySlimTaskInstanceWithActionAndEntities | ActivitySlimTaskInstanceWithAction>;
2010
- pagination?: ActivityPaginationOutput | null;
2011
- };
2012
- type ActivityTaskInstanceSearch = {
2013
- q?: string | null;
2014
- };
2015
- type ActivityTaskInstanceUpdate = {
2016
- name?: string | null;
2017
- description?: string | null;
2018
- due_date?: string | null;
2019
- assignee_id?: string | null;
2020
- preparer_id?: string | null;
2021
- reviewer_id?: string | null;
2022
- status?: ActivityTaskStatus | null;
2023
- preparer_due_date?: string | null;
2024
- trigger_execution_id?: string | null;
2025
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
2026
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2027
- };
2028
- /**
2029
- * Clears the task action from a task instance.
2030
- *
2031
- * Send {"task_action": null} in the PUT body to hard-delete the existing
2032
- * StoredTaskAction row. Sending {} (no key) maps to plain TaskInstanceUpdate
2033
- * and leaves any existing task action untouched.
2034
- */
2035
- type ActivityTaskInstanceUpdateClearAction = {
2036
- name?: string | null;
2037
- description?: string | null;
2038
- due_date?: string | null;
2039
- assignee_id?: string | null;
2040
- preparer_id?: string | null;
2041
- reviewer_id?: string | null;
2042
- status?: ActivityTaskStatus | null;
2043
- preparer_due_date?: string | null;
2044
- trigger_execution_id?: string | null;
2045
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
2046
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2047
- task_action: null;
2048
- };
2049
- type ActivityTaskInstanceUpdateWithAction = {
2050
- name?: string | null;
2051
- description?: string | null;
2052
- due_date?: string | null;
2053
- assignee_id?: string | null;
2054
- preparer_id?: string | null;
2055
- reviewer_id?: string | null;
2056
- status?: ActivityTaskStatus | null;
2057
- preparer_due_date?: string | null;
2058
- trigger_execution_id?: string | null;
2059
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
2060
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2061
- task_action: ActivityTaskActionInput;
2062
- };
2063
- type ActivityTaskInstanceWithAction = {
2064
- last_manually_updated?: string | null;
2065
- created_at?: string | null;
2066
- last_modified_at?: string | null;
2067
- id: string;
2068
- name: string;
2069
- due_date: string;
2070
- preparer_due_date: string;
2071
- status: ActivityTaskStatus;
2072
- description?: string | null;
2073
- task_definition_id: string;
2074
- activity_instance_id: string;
2075
- subsidiary_id: number;
2076
- is_deleted?: boolean;
2077
- preparer_id?: string | null;
2078
- assignee_id?: string | null;
2079
- reconciled?: boolean | null;
2080
- creator?: ActivityTaskCreator | null;
2081
- decline_reason?: string | null;
2082
- trigger_execution_id?: string | null;
2083
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
2084
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2085
- is_currently_blocked?: boolean | null;
2086
- is_blocking_manually_set?: boolean;
2087
- task_type?: ActivityTaskType | null;
2088
- attachments_count?: number;
2089
- task_action?: ActivityTaskActionOutput | null;
2090
- task_action_type?: string | null;
2091
- is_manual_task?: boolean | null;
2092
- activity_name?: string | null;
2093
- period_display_id?: string | null;
2094
- activity_definition_id?: string | null;
2095
- task_action_execution_errors?: Array<ActivityTaskActionExecutionError> | null;
2096
- };
2097
- type ActivityTaskInstanceWithActivity = {
2098
- last_manually_updated?: string | null;
2099
- created_at?: string | null;
2100
- last_modified_at?: string | null;
2101
- id: string;
2102
- name: string;
2103
- due_date: string;
2104
- preparer_due_date: string;
2105
- status: ActivityTaskStatus;
2106
- description?: string | null;
2107
- task_definition_id: string;
2108
- activity_instance_id: string;
2109
- subsidiary_id: number;
2110
- is_deleted?: boolean;
2111
- preparer_id?: string | null;
2112
- assignee_id?: string | null;
2113
- reconciled?: boolean | null;
2114
- creator?: ActivityTaskCreator | null;
2115
- decline_reason?: string | null;
2116
- trigger_execution_id?: string | null;
2117
- blocks_tasks?: Array<ActivityTaskBlocking> | null;
2118
- blocked_by_tasks?: Array<ActivityTaskBlocking> | null;
2119
- is_currently_blocked?: boolean | null;
2120
- is_blocking_manually_set?: boolean;
2121
- task_type?: ActivityTaskType | null;
2122
- attachments_count?: number;
2123
- task_action?: ActivityTaskActionOutput | null;
2124
- task_action_type?: string | null;
2125
- is_manual_task?: boolean | null;
2126
- activity_name?: string | null;
2127
- period_display_id?: string | null;
2128
- activity_definition_id?: string | null;
2129
- task_action_execution_errors?: Array<ActivityTaskActionExecutionError> | null;
2130
- activity_instance: ActivityActivityInstance;
2131
- };
2132
- type ActivityTaskStatus = 'DONE' | 'PENDING' | 'IN_REVIEW' | 'IN_PROGRESS' | 'CANCELLED' | 'FAILED' | 'DRAFT';
2133
- /**
2134
- * The type of the task definition
2135
- */
2136
- type ActivityTaskType = 'RECONCILIATION';
2137
- type ActivityTasksProgress = {
2138
- done?: number;
2139
- review?: number;
2140
- pending?: number;
2141
- declined?: number;
2142
- total?: number;
2143
- };
2144
- type ActivityTestActionData = {
2145
- action_type?: 'test_action';
2146
- name: string;
2147
- };
2148
- type ActivityTestActionTemplate = {
2149
- action_type?: 'test_action';
2150
- name: string;
2151
- };
2152
- type ActivityTestScheduleActionTemplate = {
2153
- action_type?: 'test_schedule_action';
2154
- name: string;
2155
- };
2156
- type ActivityTimeframe = {
2157
- tf_type?: ActivityTimeframeType;
2158
- offset?: number;
2159
- periods?: number;
2160
- unit?: ActivityTimeframeUnit;
2161
- from_date?: string | null;
2162
- to_date?: string | null;
2163
- };
2164
- type ActivityTimeframeType = 'all' | 'custom' | 'full_periods' | 'last_periods' | 'ytd';
2165
- type ActivityTimeframeUnit = 'day' | 'week' | 'month' | 'quarter' | 'year';
2166
- type ActivityWriteBackStatusInput = {
2167
- id: string;
2168
- transaction_id: string;
2169
- journal_entry_id: string;
2170
- status: ActivityJeWriteBackStatus;
2171
- provider_uid?: string | null;
2172
- error_message?: string | null;
2173
- error_type?: ActivityProviderOperationErrorType | null;
2174
- last_modified_time?: string | null;
2175
- };
2176
- type ActivityWriteBackStatusOutput = {
2177
- id: string;
2178
- transaction_id: string;
2179
- journal_entry_id: string;
2180
- status: ActivityJeWriteBackStatus;
2181
- provider_uid?: string | null;
2182
- error_message?: string | null;
2183
- error_type?: ActivityProviderOperationErrorType | null;
2184
- last_modified_time?: string | null;
2185
- readonly display_error_message: string;
2186
- };
2187
- type AuditTrailAuditTrailEvent = {
2188
- id: string;
2189
- time: string;
2190
- action: string;
2191
- actor: AuditTrailAuditTrailEventActor;
2192
- subsidiary_id: number;
2193
- target: AuditTrailEntityRef;
2194
- additional_data?: {
2195
- [key: string]: unknown;
2196
- } | null;
2197
- old_value?: {
2198
- [key: string]: unknown;
2199
- } | null;
2200
- new_value?: {
2201
- [key: string]: unknown;
2202
- } | null;
2203
- message: string;
2204
- };
2205
- type AuditTrailAuditTrailEventActor = {
2206
- entity_id: string | null;
2207
- entity_type: AuditTrailEventActorType;
2208
- entity_name?: string | null;
2209
- [key: string]: unknown | (string | null) | AuditTrailEventActorType | (string | null) | undefined;
2210
- };
2211
- type AuditTrailEntityRef = {
2212
- entity_id: string;
2213
- entity_type: AuditTrailEntityType;
2214
- entity_name?: string | null;
2215
- [key: string]: unknown | string | AuditTrailEntityType | (string | null) | undefined;
2216
- };
2217
- type AuditTrailEntityType = 'TENANT' | 'SUBSIDIARY' | 'LEASE' | 'ACTIVITY_DEFINITION' | 'ACTIVITY_INSTANCE' | 'PERIOD_INSTANCE' | 'TASK_DEFINITION' | 'TASK_INSTANCE' | 'TRIGGER' | 'USER' | 'JOURNAL_ENTRY' | 'ACCOUNT' | 'BILL' | 'ICT';
2218
- type AuditTrailEventActorType = 'USER' | 'TRIGGER' | 'WORKFLOW' | 'SYSTEM';
2219
- type AuditTrailGetEntityAuditTrailArgs = {
2220
- target_id: string;
2221
- target_type: AuditTrailEntityType;
2222
- include_before?: boolean;
2223
- include_after?: boolean;
2224
- };
2225
- /**
2226
- * Fiscal calendar domain model with audit timestamps
2227
- *
2228
- * Inherits core fields from `FiscalCalendarCreate` and is used as the
2229
- * persisted/read model across services.
2230
- */
2231
- type PeriodManagerFiscalCalendar = {
2232
- created_at?: string | null;
2233
- last_modified_at?: string | null;
2234
- id: string;
2235
- name: string;
2236
- start_month: number;
2237
- subsidiary_id: number;
2238
- config?: PeriodManagerFiscalCalendarConfig | null;
2239
- };
2240
- /**
2241
- * Configuration options for a fiscal calendar.
2242
- *
2243
- * :param shift_backwards: If False (default), the fiscal year name uses the
2244
- * year from the start date (e.g., 2025-07-01 to 2026-06-30 -> FY 2025).
2245
- * If True, uses the year from the end date (e.g., FY 2026).
2246
- * :param force_p_naming: If True, use P01, P02, etc. naming for periods
2247
- * even for standard January-December calendars.
2248
- */
2249
- type PeriodManagerFiscalCalendarConfig = {
2250
- shift_backwards?: boolean;
2251
- force_p_naming?: boolean;
2252
- };
2253
- 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';
2254
- type TenancySubsidiary = {
2255
- company_name: string;
2256
- legal_name: string;
2257
- description?: string | null;
2258
- created_time?: string | null;
2259
- modified_time?: string | null;
2260
- fully_synced?: boolean;
2261
- is_active?: boolean;
2262
- business_summary?: string | null;
2263
- id?: number | null;
2264
- default_currency: TenancyCurrency;
2265
- tenant_id: string;
2266
- parent_company_id?: number | null;
2267
- provider_id?: number | null;
2268
- children?: Array<TenancySubsidiaryCreate>;
2269
- is_elimination_subsidiary?: boolean | null;
2270
- is_organization_top?: boolean | null;
2271
- organization_id?: number | null;
2272
- provider_uid?: string | null;
2273
- parent_company?: TenancySubsidiary | null;
2274
- attachments?: Array<TenancySubsidiaryAttachment>;
2275
- };
2276
- type TenancySubsidiaryApiResponse = {
2277
- company_name: string;
2278
- legal_name: string;
2279
- description?: string | null;
2280
- created_time?: string | null;
2281
- modified_time?: string | null;
2282
- fully_synced?: boolean;
2283
- is_active?: boolean;
2284
- business_summary?: string | null;
2285
- id?: number | null;
2286
- default_currency: TenancyCurrency;
2287
- tenant_id: string;
2288
- parent_company_id?: number | null;
2289
- provider_id?: number | null;
2290
- children?: Array<TenancySubsidiaryCreate>;
2291
- is_elimination_subsidiary?: boolean | null;
2292
- is_organization_top?: boolean | null;
2293
- organization_id?: number | null;
2294
- provider_uid?: string | null;
2295
- parent_company?: TenancySubsidiary | null;
2296
- attachments?: Array<TenancySubsidiaryAttachment>;
2297
- is_organization?: boolean;
2298
- is_parent_subsidiary?: boolean;
2299
- is_nominal_subsidiary?: boolean;
2300
- };
2301
- type TenancySubsidiaryAttachment = {
2302
- attachment_id: string;
2303
- attachment_type: TenancySubsidiaryAttachmentType;
2304
- attachment_date?: string;
2305
- processing_status?: TenancySubsidiaryAttachmentProcessingStatus;
2306
- error_message?: string | null;
2307
- should_use_top_coa?: boolean;
2308
- created_time?: string | null;
2309
- };
2310
- type TenancySubsidiaryAttachmentProcessingStatus = 'PENDING' | 'ACTIVE' | 'FAILED';
2311
- type TenancySubsidiaryAttachmentType = 'BVA';
2312
- type TenancySubsidiaryCreate = {
2313
- company_name: string;
2314
- legal_name: string;
2315
- description?: string | null;
2316
- created_time?: string | null;
2317
- modified_time?: string | null;
2318
- fully_synced?: boolean;
2319
- is_active?: boolean;
2320
- business_summary?: string | null;
2321
- id?: number | null;
2322
- default_currency: TenancyCurrency;
2323
- tenant_id: string;
2324
- parent_company_id?: number | null;
2325
- provider_id?: number | null;
2326
- children?: Array<TenancySubsidiaryCreate>;
2327
- is_elimination_subsidiary?: boolean | null;
2328
- is_organization_top?: boolean | null;
2329
- organization_id?: number | null;
2330
- provider_uid?: string | null;
2331
- };
2332
- type TenancyUser = {
2333
- id?: string;
2334
- email?: string;
2335
- name?: string;
2336
- status?: TenancyUserStatus;
2337
- picture?: string;
2338
- custom_attributes?: {
2339
- [key: string]: unknown;
2340
- };
2341
- };
2342
- type TenancyUserStatus = 'invited' | 'enabled' | 'disabled';
2343
- type GetAccountsApiAccountingAccountGetData = {
2344
- body?: never;
2345
- path?: never;
2346
- query?: {
2347
- account_ids?: Array<string> | null;
2348
- };
2349
- url: '/api/accounting/account';
2350
- };
2351
- type GetAccountsApiAccountingAccountGetResponses = {
2352
- /**
2353
- * Successful Response
2354
- */
2355
- 200: Array<AccountingTAccountOutput>;
2356
- };
2357
- type GetAccountsApiAccountingAccountGetResponse = GetAccountsApiAccountingAccountGetResponses[keyof GetAccountsApiAccountingAccountGetResponses];
2358
- type GetAccountApiAccountingAccountAccountIdGetData = {
2359
- body?: never;
2360
- path: {
2361
- account_id: string;
2362
- };
2363
- query?: never;
2364
- url: '/api/accounting/account/{account_id}';
2365
- };
2366
- type GetAccountApiAccountingAccountAccountIdGetResponses = {
2367
- /**
2368
- * Successful Response
2369
- */
2370
- 200: AccountingTAccountWithSubAccounts;
2371
- };
2372
- type GetAccountApiAccountingAccountAccountIdGetResponse = GetAccountApiAccountingAccountAccountIdGetResponses[keyof GetAccountApiAccountingAccountAccountIdGetResponses];
2373
- type GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetData = {
2374
- body?: never;
2375
- path: {
2376
- subsidiary_id: number;
2377
- };
2378
- query?: {
2379
- account_subsidiary_ids?: Array<number>;
2380
- from_date?: string;
2381
- to_date?: string;
2382
- ignore_elimination_balance?: boolean;
2383
- is_normalized?: boolean;
2384
- };
2385
- url: '/api/accounting/subsidiary/{subsidiary_id}/coa';
2386
- };
2387
- type GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponses = {
2388
- /**
2389
- * Successful Response
2390
- */
2391
- 200: Array<AccountingTAccountWithSubAccounts>;
2392
- };
2393
- type GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponse = GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponses[keyof GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponses];
2394
- type GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetData = {
2395
- body?: AccountingPaginationPositionInput | null;
2396
- path: {
2397
- subsidiary_id: number;
2398
- };
2399
- query?: {
2400
- account_subsidiary_ids?: Array<number>;
2401
- account_type?: Array<AccountingAccountType>;
2402
- accounting_class?: Array<AccountingAccountingClass>;
2403
- exclude_account_ids?: Array<string>;
2404
- from_date?: string;
2405
- to_date?: string;
2406
- with_direct_balance?: boolean;
2407
- with_no_balance?: boolean;
2408
- ignore_elimination_balance?: boolean;
2409
- is_normalized?: boolean;
2410
- page?: number | null;
2411
- per_page?: number | null;
2412
- include_total?: boolean;
2413
- sort?: AccountingSortableFieldsCoa;
2414
- order?: AccountingSortingOrder | null;
2415
- q?: string | null;
2416
- };
2417
- url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account';
2418
- };
2419
- type GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponses = {
2420
- /**
2421
- * Successful Response
2422
- */
2423
- 200: AccountingCoaPaginationOutput | Array<AccountingTAccountOutput>;
2424
- };
2425
- type GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponse = GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponses[keyof GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponses];
2426
- type GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetData = {
2427
- body?: never;
2428
- path: {
2429
- subsidiary_id: number;
2430
- };
2431
- query?: {
2432
- ignore_inactive_accounts?: boolean;
2433
- };
2434
- url: '/api/accounting/subsidiary/{subsidiary_id}/coa/available-currencies';
2435
- };
2436
- type GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponses = {
2437
- /**
2438
- * Successful Response
2439
- */
2440
- 200: Array<AccountingCurrency>;
2441
- };
2442
- type GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponse = GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponses[keyof GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponses];
2443
- type GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetData = {
2444
- body?: AccountingPaginationPositionInput | null;
2445
- path: {
2446
- subsidiary_id: number;
2447
- };
2448
- query?: {
2449
- account_subsidiary_ids?: Array<number>;
2450
- account_ids?: Array<string>;
2451
- exclude_account_ids?: Array<string>;
2452
- account_type?: Array<AccountingAccountType>;
2453
- accounting_class?: Array<AccountingAccountingClass>;
2454
- ignore_elimination_balance?: boolean;
2455
- ignore_inactive_accounts?: boolean;
2456
- is_normalized?: boolean;
2457
- page?: number | null;
2458
- per_page?: number | null;
2459
- include_total?: boolean;
2460
- sort?: AccountingSortableFieldsCoa;
2461
- order?: AccountingSortingOrder | null;
2462
- q?: string | null;
2463
- };
2464
- url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account/simple';
2465
- };
2466
- type GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponses = {
2467
- /**
2468
- * Successful Response
2469
- */
2470
- 200: AccountingSimpleCoAPaginationOutput | Array<AccountingSimpleTAccount>;
2471
- };
2472
- type GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponse = GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponses[keyof GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponses];
2473
- type GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetData = {
2474
- body?: never;
2475
- path: {
2476
- subsidiary_id: number;
2477
- };
2478
- query: {
2479
- group_by: AccountingCoAGroupBy;
2480
- account_subsidiary_ids?: Array<number>;
2481
- from_date?: string;
2482
- to_date?: string;
2483
- with_direct_balance?: boolean;
2484
- ignore_elimination_balance?: boolean;
2485
- is_normalized?: boolean;
2486
- };
2487
- url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account/group';
2488
- };
2489
- type GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponses = {
2490
- /**
2491
- * Successful Response
2492
- */
2493
- 200: Array<AccountingGroupedAccounts>;
2494
- };
2495
- type GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponse = GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponses[keyof GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponses];
2496
- type GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetData = {
2497
- body?: never;
2498
- path: {
2499
- subsidiary_id: number;
2500
- account_id: string;
2501
- };
2502
- query?: {
2503
- is_normalized?: boolean;
2504
- from_date?: string;
2505
- to_date?: string;
2506
- };
2507
- url: '/api/accounting/subsidiary/{subsidiary_id}/coa/account/{account_id}';
2508
- };
2509
- type GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponses = {
2510
- /**
2511
- * Successful Response
2512
- */
2513
- 200: AccountingTAccountWithSubAccounts;
2514
- };
2515
- type GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponse = GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponses[keyof GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponses];
2516
- type GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetData = {
2517
- body?: never;
2518
- path: {
2519
- currency: AccountingCurrency;
2520
- };
2521
- query?: {
2522
- exchange_date?: string;
2523
- };
2524
- url: '/api/accounting/currency/{currency}/conversion-rates';
2525
- };
2526
- type GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponses = {
2527
- /**
2528
- * Successful Response
2529
- */
2530
- 200: AccountingExchangeRates;
2531
- };
2532
- type GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponse = GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponses[keyof GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponses];
2533
- type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetData = {
2534
- body?: AccountingPaginationPositionInput | null;
2535
- path: {
2536
- subsidiary_id: number;
2537
- };
2538
- query?: {
2539
- entry_types?: Array<AccountingJournalEntryType> | null;
2540
- ref_numbers?: Array<string> | null;
2541
- child_subsidiaries?: Array<number> | null;
2542
- from_date?: string | null;
2543
- to_date?: string | null;
2544
- is_nominal_ledger?: boolean | null;
2545
- memo?: string | null;
2546
- journal_entry_line_ids?: Array<string> | null;
2547
- page?: number | null;
2548
- per_page?: number | null;
2549
- include_total?: boolean;
2550
- sort?: 'date' | 'transaction_type' | 'memo' | 'ref_number';
2551
- order?: AccountingSortingOrder | null;
2552
- };
2553
- url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry/lines';
2554
- };
2555
- type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses = {
2556
- /**
2557
- * Successful Response
2558
- */
2559
- 200: Array<AccountingJournalEntryLineWithJournalEntryWithDimensionsWithOperationCtx> | AccountingJournalEntryLinePaginationOutput;
2560
- };
2561
- type GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponse = GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses[keyof GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponses];
2562
- type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData = {
2563
- body?: AccountingPaginationPositionInput | null;
2564
- path: {
2565
- subsidiary_id: number;
2566
- };
2567
- query?: {
2568
- entry_types?: Array<AccountingJournalEntryType> | null;
2569
- ref_numbers?: Array<string> | null;
2570
- child_subsidiaries?: Array<number> | null;
2571
- from_date?: string | null;
2572
- to_date?: string | null;
2573
- is_nominal_ledger?: boolean | null;
2574
- memo?: string | null;
2575
- entry_statuses?: Array<AccountingJournalEntryStatus> | null;
2576
- /**
2577
- * Filter entries where any line has this amount
2578
- */
2579
- line_amount?: number | null;
2580
- page?: number | null;
2581
- per_page?: number | null;
2582
- include_total?: boolean;
2583
- sort?: 'date' | 'transaction_type' | 'memo' | 'ref_number';
2584
- order?: AccountingSortingOrder | null;
2585
- };
2586
- url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry';
2587
- };
2588
- type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponses = {
2589
- /**
2590
- * Successful Response
2591
- */
2592
- 200: Array<AccountingJournalEntryDimensionsWithOperationCtx> | AccountingJournalEntryPaginationOutput;
2593
- };
2594
- type GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponse = GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponses[keyof GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponses];
2595
- type GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetData = {
2596
- body?: never;
2597
- path: {
2598
- journal_entry_id: string;
2599
- subsidiary_id: number;
2600
- };
2601
- query?: never;
2602
- url: '/api/accounting/subsidiary/{subsidiary_id}/journal-entry/{journal_entry_id}';
2603
- };
2604
- type GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponses = {
2605
- /**
2606
- * Successful Response
2607
- */
2608
- 200: AccountingJournalEntryDimensionsWithOperationCtx;
2609
- };
2610
- type GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponse = GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponses[keyof GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponses];
2611
- type GetDimensionsApiAccountingDimensionGetData = {
2612
- body?: never;
2613
- path?: never;
2614
- query?: {
2615
- subsidiary_id?: number | null;
2616
- values_limit?: number | null;
2617
- with_rules_and_values?: boolean;
2618
- };
2619
- url: '/api/accounting/dimension';
2620
- };
2621
- type GetDimensionsApiAccountingDimensionGetResponses = {
2622
- /**
2623
- * Successful Response
2624
- */
2625
- 200: Array<AccountingDimensionWithRules>;
2626
- };
2627
- type GetDimensionsApiAccountingDimensionGetResponse = GetDimensionsApiAccountingDimensionGetResponses[keyof GetDimensionsApiAccountingDimensionGetResponses];
2628
- type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetData = {
2629
- body?: never;
2630
- path: {
2631
- dimension_id: string;
2632
- account_id: string;
2633
- };
2634
- query?: never;
2635
- url: '/api/accounting/dimension/{dimension_id}/account/{account_id}';
2636
- };
2637
- type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponses = {
2638
- /**
2639
- * Successful Response
2640
- */
2641
- 200: AccountingAccountDimensionValues;
2642
- };
2643
- type GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponse = GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponses[keyof GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponses];
2644
- type GetDimensionValuesApiAccountingDimensionValueGetData = {
2645
- body?: never;
2646
- path?: never;
2647
- query?: {
2648
- dimension_ids?: Array<string> | null;
2649
- dimension_value_ids?: Array<string> | null;
2650
- dimension_name?: string | null;
2651
- dimension_value?: string | null;
2652
- slim?: boolean;
2653
- /**
2654
- * Sort dimension values alphabetically by value
2655
- */
2656
- sort_alphabetically?: boolean;
2657
- };
2658
- url: '/api/accounting/dimension-value';
2659
- };
2660
- type GetDimensionValuesApiAccountingDimensionValueGetResponses = {
2661
- /**
2662
- * Successful Response
2663
- */
2664
- 200: Array<AccountingDimensionValueWithRulesAndChildren | AccountingDimensionValueSlim | AccountingDimensionValue> | [
2665
- Array<AccountingDimensionValueWithRulesAndChildren | AccountingDimensionValueSlim | AccountingDimensionValue>,
2666
- AccountingPaginationOutput
2667
- ];
2668
- };
2669
- type GetDimensionValuesApiAccountingDimensionValueGetResponse = GetDimensionValuesApiAccountingDimensionValueGetResponses[keyof GetDimensionValuesApiAccountingDimensionValueGetResponses];
2670
- type GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetData = {
2671
- body?: never;
2672
- path?: never;
2673
- query?: {
2674
- dimension_id?: string | null;
2675
- dimension_name?: string | null;
2676
- parent_id?: string | null;
2677
- search_query?: string | null;
2678
- include_ids?: Array<string> | null;
2679
- slim?: boolean;
2680
- };
2681
- url: '/api/accounting/dimension-value/hierarchical';
2682
- };
2683
- type GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponses = {
2684
- /**
2685
- * Successful Response
2686
- */
2687
- 200: [
2688
- Array<AccountingDimensionValueWithChildren> | Array<AccountingDimensionValueSlim>,
2689
- AccountingPaginationOutput | null
2690
- ];
2691
- };
2692
- type GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponse = GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponses[keyof GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponses];
2693
- type GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetData = {
2694
- body?: AccountingPaginationPositionInput | null;
2695
- path?: never;
2696
- query?: {
2697
- from_subsidiary?: Array<number> | null;
2698
- to_subsidiary?: Array<number> | null;
2699
- page?: number | null;
2700
- per_page?: number | null;
2701
- include_total?: boolean;
2702
- sort?: AccountingSortableFieldsCer;
2703
- order?: AccountingSortingOrder | null;
2704
- };
2705
- url: '/api/accounting/consolidation-exchange-rate';
2706
- };
2707
- type GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponses = {
2708
- /**
2709
- * Successful Response
2710
- */
2711
- 200: AccountingCerPaginationOutput;
2712
- };
2713
- type GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponse = GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponses[keyof GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponses];
2714
- type GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetData = {
2715
- body?: never;
2716
- path: {
2717
- input_date: string;
2718
- };
2719
- query?: never;
2720
- url: '/api/accounting/consolidation-exchange-rate/period/{input_date}';
2721
- };
2722
- type GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponses = {
2723
- /**
2724
- * Successful Response
2725
- */
2726
- 200: AccountingConsolidationExchangeRatePeriod;
2727
- };
2728
- type GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponse = GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponses[keyof GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponses];
2729
- type GetActivityDefinitionsApiActivityActivityDefinitionGetData = {
2730
- body?: never;
2731
- path?: never;
2732
- query?: {
2733
- with_disabled_activity?: boolean;
2734
- with_task_definitions?: boolean;
2735
- };
2736
- url: '/api/activity/activity-definition';
2737
- };
2738
- type GetActivityDefinitionByIdApiActivityActivityDefinitionActivityDefinitionIdGetData = {
2739
- body?: never;
2740
- path: {
2741
- activity_definition_id: string;
2742
- };
2743
- query?: {
2744
- with_task_definitions?: boolean;
2745
- };
2746
- url: '/api/activity/activity-definition/{activity_definition_id}';
2747
- };
2748
- type GetPeriodInstancesApiActivityPeriodInstanceGetData = {
2749
- body?: never;
2750
- path?: never;
2751
- query?: {
2752
- period?: ActivityPeriod | null;
2753
- slim?: boolean;
2754
- from_date?: string | null;
2755
- to_date?: string | null;
2756
- ref_date?: string | null;
2757
- };
2758
- url: '/api/activity/period-instance';
2759
- };
2760
- type GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData = {
2761
- body?: never;
2762
- path: {
2763
- period_instance_id: string;
2764
- };
2765
- query?: {
2766
- with_disabled_activity?: boolean;
2767
- include_children?: boolean;
2768
- subsidiary_ids?: Array<number> | null;
2769
- };
2770
- url: '/api/activity/period-instance/{period_instance_id}';
2771
- };
2772
- type GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData = {
2773
- body?: never;
2774
- path: {
2775
- period_display_id: string;
2776
- };
2777
- query?: {
2778
- with_disabled_activity?: boolean;
2779
- include_children?: boolean;
2780
- subsidiary_ids?: Array<number> | null;
2781
- /**
2782
- * Filter by activity definition IDs
2783
- */
2784
- activity_definition_ids?: Array<string> | null;
2785
- exclude_task_types?: Array<ActivityTaskType> | null;
2786
- include_task_types?: Array<ActivityTaskType> | null;
2787
- };
2788
- url: '/api/activity/period-instance/by-slug/{period_display_id}';
2789
- };
2790
- type GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetData = {
2791
- body?: never;
2792
- path: {
2793
- period_display_id: string;
2794
- };
2795
- query?: {
2796
- /**
2797
- * Maximum number of subsidiaries to return globally (max 50)
2798
- */
2799
- max_subsidiaries?: number;
2800
- /**
2801
- * Filter by specific subsidiary IDs
2802
- */
2803
- subsidiary_ids?: Array<number> | null;
2804
- /**
2805
- * Filter by activity definition IDs
2806
- */
2807
- activity_definition_ids?: Array<string> | null;
2808
- };
2809
- url: '/api/activity/period-instance/by-slug/{period_display_id}/progress-breakdown';
2810
- };
2811
- type GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponses = {
2812
- /**
2813
- * Successful Response
2814
- */
2815
- 200: ActivityPeriodInstanceProgressBreakdownApi;
2816
- };
2817
- type GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponse = GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponses[keyof GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponses];
2818
- type GetAllTasksDefinitionsApiActivityTaskDefinitionGetData = {
2819
- body?: never;
2820
- path?: never;
2821
- query?: {
2822
- entity_id?: string | null;
2823
- with_instances?: boolean;
2824
- };
2825
- url: '/api/activity/task-definition';
2826
- };
2827
- type GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponses = {
2828
- /**
2829
- * Successful Response
2830
- */
2831
- 200: Array<ActivitySlimTaskDefinitionWithInstances>;
2832
- };
2833
- type GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponse = GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponses[keyof GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponses];
2834
- type CreateTaskDefinitionApiActivityTaskDefinitionPostData = {
2835
- body: ActivityTaskDefinitionWithActionCreateApi;
2836
- path?: never;
2837
- query?: never;
2838
- url: '/api/activity/task-definition';
2839
- };
2840
- type CreateTaskDefinitionApiActivityTaskDefinitionPostResponses = {
2841
- /**
2842
- * Successful Response
2843
- */
2844
- 200: ActivityTaskDefinition;
2845
- };
2846
- type CreateTaskDefinitionApiActivityTaskDefinitionPostResponse = CreateTaskDefinitionApiActivityTaskDefinitionPostResponses[keyof CreateTaskDefinitionApiActivityTaskDefinitionPostResponses];
2847
- type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData = {
2848
- body?: never;
2849
- path?: never;
2850
- query?: {
2851
- entity_ids?: Array<string>;
2852
- entity_type?: ActivityTaskEntityType | null;
2853
- with_instances?: boolean;
2854
- q?: string | null;
2855
- };
2856
- url: '/api/activity/task-definition/query';
2857
- };
2858
- type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponses = {
2859
- /**
2860
- * Successful Response
2861
- */
2862
- 200: Array<ActivitySlimTaskDefinitionWithInstances>;
2863
- };
2864
- type GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponse = GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponses[keyof GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponses];
2865
- type GetTaskDefinitionByIdApiActivityTaskDefinitionTaskDefinitionIdGetData = {
2866
- body?: never;
2867
- path: {
2868
- task_definition_id: string;
2869
- };
2870
- query?: {
2871
- include_draft?: boolean;
2872
- with_instances?: boolean;
2873
- with_action_template?: boolean;
2874
- };
2875
- url: '/api/activity/task-definition/{task_definition_id}';
2876
- };
2877
- type UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutData = {
2878
- body: ActivityTaskDefinitionUpdate;
2879
- path: {
2880
- task_definition_id: string;
2881
- };
2882
- query?: {
2883
- should_override_instances?: boolean;
2884
- };
2885
- url: '/api/activity/task-definition/{task_definition_id}';
2886
- };
2887
- type UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponses = {
2888
- /**
2889
- * Successful Response
2890
- */
2891
- 200: ActivityTaskDefinition;
2892
- };
2893
- type UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponse = UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponses[keyof UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponses];
2894
- type GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData = {
2895
- body?: never;
2896
- path: {
2897
- activity_instance_id: string;
2898
- };
2899
- query?: {
2900
- with_slim_task_instances?: boolean;
2901
- with_instances?: boolean;
2902
- for_reconciliation?: boolean;
2903
- subsidiary_ids?: Array<number> | null;
2904
- };
2905
- url: '/api/activity/activity-instance/{activity_instance_id}';
2906
- };
2907
- type GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTaskGetData = {
2908
- body?: ActivityPaginationPositionInput | null;
2909
- path: {
2910
- activity_instance_id: string;
2911
- };
2912
- query?: {
2913
- is_deleted?: boolean | null;
2914
- include_draft?: boolean;
2915
- subsidiary_ids?: Array<number> | null;
2916
- status?: Array<ActivityTaskStatus> | null;
2917
- preparer_ids?: Array<string> | null;
2918
- reviewer_ids?: Array<string> | null;
2919
- due_date_period?: ActivityPeriodFilter;
2920
- due_date_from?: string;
2921
- due_date_to?: string;
2922
- slim?: boolean;
2923
- without_activity_instance?: boolean;
2924
- page?: number | null;
2925
- per_page?: number | null;
2926
- include_total?: boolean;
2927
- sort?: ActivitySortableFieldsTask;
2928
- order?: ActivitySortingOrder | null;
2929
- q?: string | null;
2930
- };
2931
- url: '/api/activity/activity-instance/{activity_instance_id}/task';
2932
- };
2933
- type GetActivityInstancesApiActivityActivityInstanceGetData = {
2934
- body?: never;
2935
- path?: never;
2936
- query?: {
2937
- period_instance_id?: string | null;
2938
- activity_definition_id?: string | null;
2939
- from_date?: string | null;
2940
- to_date?: string | null;
2941
- as_enriched?: boolean;
2942
- };
2943
- url: '/api/activity/activity-instance';
2944
- };
2945
- type GetActivityInstancesApiActivityActivityInstanceGetResponses = {
2946
- /**
2947
- * Successful Response
2948
- */
2949
- 200: Array<ActivityApiEnrichedActivityInstance | ActivityActivityInstanceWithTaskInstances>;
2950
- };
2951
- type GetActivityInstancesApiActivityActivityInstanceGetResponse = GetActivityInstancesApiActivityActivityInstanceGetResponses[keyof GetActivityInstancesApiActivityActivityInstanceGetResponses];
2952
- type GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetData = {
2953
- body?: never;
2954
- path: {
2955
- period_display_id: string;
2956
- activity_definition_id: string;
2957
- };
2958
- query?: {
2959
- with_slim_task_instances?: boolean;
2960
- with_instances?: boolean;
2961
- for_reconciliation?: boolean;
2962
- subsidiary_ids?: Array<number> | null;
2963
- };
2964
- url: '/api/activity/activity-instance/by-period/{period_display_id}/{activity_definition_id}';
2965
- };
2966
- type GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponses = {
2967
- /**
2968
- * Successful Response
2969
- */
2970
- 200: ActivityApiEnrichedActivityInstance;
2971
- };
2972
- type GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponse = GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponses[keyof GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponses];
2973
- type GetTaskInstancesByActivityPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdTaskGetData = {
2974
- body?: ActivityPaginationPositionInput | null;
2975
- path: {
2976
- period_display_id: string;
2977
- activity_definition_id: string;
2978
- };
2979
- query?: {
2980
- is_deleted?: boolean | null;
2981
- include_draft?: boolean;
2982
- subsidiary_ids?: Array<number> | null;
2983
- status?: Array<ActivityTaskStatus> | null;
2984
- preparer_ids?: Array<string> | null;
2985
- reviewer_ids?: Array<string> | null;
2986
- slim?: boolean;
2987
- without_activity_instance?: boolean;
2988
- exclude_task_types?: Array<ActivityTaskType> | null;
2989
- page?: number | null;
2990
- per_page?: number | null;
2991
- include_total?: boolean;
2992
- sort?: ActivitySortableFieldsTask;
2993
- order?: ActivitySortingOrder | null;
2994
- q?: string | null;
2995
- };
2996
- url: '/api/activity/activity-instance/by-period/{period_display_id}/{activity_definition_id}/task';
2997
- };
2998
- type GetAllTaskInstancesApiActivityTaskInstanceGetData = {
2999
- body?: never;
3000
- path?: never;
3001
- query?: {
3002
- status?: Array<ActivityTaskStatus>;
3003
- subsidiary_ids?: Array<number>;
3004
- activity_definition_ids?: Array<string>;
3005
- preparer_ids?: Array<string> | null;
3006
- reviewer_ids?: Array<string> | null;
3007
- period_instance_id?: string | null;
3008
- period_display_id?: string | null;
3009
- period_instance_ids?: Array<string> | null;
3010
- period_display_ids?: Array<string> | null;
3011
- exclude_task_types?: Array<ActivityTaskType> | null;
3012
- slim?: boolean;
3013
- sort?: ActivitySortableFieldsTask;
3014
- order?: ActivitySortingOrder | null;
3015
- q?: string | null;
3016
- };
3017
- url: '/api/activity/task-instance';
3018
- };
3019
- type GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostData = {
3020
- body?: ActivityBodyGetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPost;
3021
- path?: never;
3022
- query?: {
3023
- sort?: ActivitySortableFieldsTask;
3024
- order?: ActivitySortingOrder | null;
3025
- };
3026
- url: '/api/activity/task-instance/query';
3027
- };
3028
- type GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponses = {
3029
- /**
3030
- * Successful Response
3031
- */
3032
- 200: ActivityTaskInstancePaginationOutput;
3033
- };
3034
- type GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponse = GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponses[keyof GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponses];
3035
- type GetTaskInstanceByIdApiActivityTaskInstanceTaskInstanceIdGetData = {
3036
- body?: never;
3037
- path: {
3038
- task_instance_id: string;
3039
- };
3040
- query?: {
3041
- with_task_action?: boolean;
3042
- };
3043
- url: '/api/activity/task-instance/{task_instance_id}';
3044
- };
3045
- type UpdateTaskInstanceApiActivityTaskInstanceTaskInstanceIdPutData = {
3046
- body: ActivityTaskInstanceUpdateWithAction | ActivityTaskInstanceUpdateClearAction | ActivityTaskInstanceUpdate;
3047
- path: {
3048
- task_instance_id: string;
3049
- };
3050
- query?: never;
3051
- url: '/api/activity/task-instance/{task_instance_id}';
3052
- };
3053
- type GetEventsApiAuditTrailEventGetData = {
3054
- body?: never;
3055
- path?: never;
3056
- query?: never;
3057
- url: '/api/audit-trail/event';
3058
- };
3059
- type GetEventsApiAuditTrailEventGetResponses = {
3060
- /**
3061
- * Successful Response
3062
- */
3063
- 200: Array<AuditTrailAuditTrailEvent>;
3064
- };
3065
- type GetEventsApiAuditTrailEventGetResponse = GetEventsApiAuditTrailEventGetResponses[keyof GetEventsApiAuditTrailEventGetResponses];
3066
- type GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostData = {
3067
- body?: Array<AuditTrailGetEntityAuditTrailArgs> | null;
3068
- path: {
3069
- target_type: AuditTrailEntityType;
3070
- target_id: string;
3071
- };
3072
- query?: never;
3073
- url: '/api/audit-trail/event/entity/{target_type}/{target_id}';
3074
- };
3075
- type GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponses = {
3076
- /**
3077
- * Successful Response
3078
- */
3079
- 200: Array<AuditTrailAuditTrailEvent>;
3080
- };
3081
- type GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponse = GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponses[keyof GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponses];
3082
- type GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetData = {
3083
- body?: never;
3084
- path: {
3085
- subsidiary_id: number;
3086
- };
3087
- query?: never;
3088
- url: '/api/period-manager/fiscal-calendar/by-subsidiary/{subsidiary_id}';
3089
- };
3090
- type GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponses = {
3091
- /**
3092
- * Successful Response
3093
- */
3094
- 200: Array<PeriodManagerFiscalCalendar>;
3095
- };
3096
- type GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponse = GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponses[keyof GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponses];
3097
- type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetData = {
3098
- body?: never;
3099
- path: {
3100
- calendar_id: string;
3101
- };
3102
- query?: never;
3103
- url: '/api/period-manager/fiscal-calendar/{calendar_id}';
3104
- };
3105
- type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponses = {
3106
- /**
3107
- * Successful Response
3108
- */
3109
- 200: PeriodManagerFiscalCalendar;
3110
- };
3111
- type GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse = GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponses[keyof GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponses];
3112
- type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData = {
3113
- body?: never;
3114
- path: {
3115
- tenant_id_or_name: string;
3116
- };
3117
- query?: never;
3118
- url: '/api/tenancy/tenant/{tenant_id_or_name}/users';
3119
- };
3120
- type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponses = {
3121
- /**
3122
- * Successful Response
3123
- */
3124
- 200: Array<TenancyUser>;
3125
- };
3126
- type GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponse = GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponses[keyof GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponses];
3127
- type GetAllSubsidiariesApiTenancySubsidiaryGetData = {
3128
- body?: never;
3129
- path?: never;
3130
- query?: {
3131
- is_flat?: boolean;
3132
- only_active?: boolean;
3133
- with_elimination_subsidiaries?: boolean;
3134
- q?: string | null;
3135
- };
3136
- url: '/api/tenancy/subsidiary';
3137
- };
3138
- type GetAllSubsidiariesApiTenancySubsidiaryGetResponses = {
3139
- /**
3140
- * Successful Response
3141
- */
3142
- 200: Array<TenancySubsidiaryApiResponse>;
3143
- };
3144
- type GetAllSubsidiariesApiTenancySubsidiaryGetResponse = GetAllSubsidiariesApiTenancySubsidiaryGetResponses[keyof GetAllSubsidiariesApiTenancySubsidiaryGetResponses];
3145
- type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData = {
3146
- body?: never;
3147
- path: {
3148
- subsidiary_id: number;
3149
- };
3150
- query?: {
3151
- with_elimination_subsidiaries?: boolean;
3152
- };
3153
- url: '/api/tenancy/subsidiary/{subsidiary_id}';
3154
- };
3155
- type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponses = {
3156
- /**
3157
- * Successful Response
3158
- */
3159
- 200: TenancySubsidiaryApiResponse | null;
3160
- };
3161
- type GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponse = GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponses[keyof GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponses];
3162
- type GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetData = {
3163
- body?: never;
3164
- path: {
3165
- subsidiary_id: number;
3166
- };
3167
- query?: never;
3168
- url: '/api/tenancy/subsidiary/{subsidiary_id}/parent-currencies';
3169
- };
3170
- type GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponses = {
3171
- /**
3172
- * Successful Response
3173
- */
3174
- 200: {
3175
- [key: string]: unknown;
3176
- };
3177
- };
3178
- type GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponse = GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponses[keyof GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponses];
3179
-
3180
- interface BridgeSubsidiary {
3181
- id: number;
3182
- displayName: string;
3183
- }
3184
- /**
3185
- * PostHog configuration the host supplies so the iframe can record a session
3186
- * replay (stitched into the host's recording via `recordCrossOriginIframes`)
3187
- * and emit custom events, all attributed to the **same PostHog person** as
3188
- * nom-ui.
3189
- *
3190
- * The host (nom-ui) is the single source of truth for these values — it knows
3191
- * the project key, the env-aware ingestion host, and the resolved person — and
3192
- * delivers it over the bridge (as a one-time `POSTHOG_PUSH`, separate from
3193
- * {@link ContextPayload}) so the iframe never hardcodes any of it. When the host
3194
- * has no PostHog config (recording disabled for this env/app), it sends no
3195
- * `POSTHOG_PUSH` and the bridge initializes nothing.
3196
- */
3197
- interface PostHogContext {
3198
- /** Project API key — the same PostHog project the host (nom-ui) uses. */
3199
- token: string;
3200
- /**
3201
- * **Absolute** ingestion host, e.g. `"https://us.i.posthog.com"`.
3202
- *
3203
- * Must NOT be the host's relative `/ingest` reverse-proxy path: a relative
3204
- * path resolves against the iframe's *own* (cross-origin) host and 404s.
3205
- */
3206
- apiHost: string;
3207
- /**
3208
- * Host-resolved PostHog distinct id. The bridge calls `identify()` with it so
3209
- * the iframe's recording and events attribute to the same person as the host.
3210
- */
3211
- distinctId: string;
3212
- /**
3213
- * **Optional.** The host's current PostHog session id (from
3214
- * `posthog.get_session_id()`). When provided, the bridge seeds it as the
3215
- * iframe instance's session via `bootstrap.sessionID`, so custom events from
3216
- * `bridge.track()` share the **same `$session_id`** as the host — letting them
3217
- * line up with the stitched session replay on one timeline.
3218
- *
3219
- * Not needed for *replay* stitching itself (that works via
3220
- * `recordCrossOriginIframes` on both sides regardless). Must be a valid UUID
3221
- * v7 — PostHog session ids already are. It is a one-time seed at connect, so
3222
- * if the host's session later rotates the two can diverge; alignment is
3223
- * best-effort for the session in progress.
3224
- */
3225
- sessionId?: string;
3226
- /**
3227
- * Master switch, env- and/or app-gated by the host. The bridge only calls
3228
- * `posthog.init()` when this is `true`; it stays the kill-switch even though
3229
- * `posthog-js` is bundled into the bridge.
3230
- */
3231
- enabled: boolean;
3232
- }
3233
- /**
3234
- * Authentication-state change the host pushes to the iframe via `AUTH_CHANGED`.
3235
- * It carries the security principal the embedded app authenticates and scopes
3236
- * its own data by. Sent when the Nominal session changes: a logout
3237
- * (`authenticated: false`) or an identity/tenant switch (`authenticated: true`
3238
- * with a new `userId`/`tenant`). The initial state is implicit at connect — the
3239
- * iframe only loads when authenticated, and the current identity/tenant are
3240
- * {@link ContextPayload.user} / {@link ContextPayload.tenant}, so apps baseline
3241
- * off those and react to this push.
3242
- *
3243
- * Subsidiary/period and other view-level state are NOT here — they ride the
3244
- * follow-up `CONTEXT_PUSH` (`onContextChange`), per "auth change, then context".
3245
- */
3246
- interface AuthPayload {
3247
- /** Whether the Nominal user is still authenticated. */
3248
- authenticated: boolean;
3249
- /** The effective Nominal user id when authenticated; omitted on logout. */
3250
- userId?: string;
3251
- /** The tenant the user is acting in — the app's data-scoping key (RLS). */
3252
- tenant?: string;
3253
- }
3254
- interface ContextPayload {
3255
- tenant: string;
3256
- subsidiaryId: number;
3257
- subsidiaries: BridgeSubsidiary[];
3258
- user: {
3259
- id: string;
3260
- displayName: string;
3261
- };
3262
- /** Initial subroute the iframe should navigate to on first load. */
3263
- subroute?: string;
3264
- /** Slug of the last closed accounting period, e.g. "mar-2026". */
3265
- lastClosedPeriodSlug?: string;
3266
- /** Version of the host SDK (@nominalso/vibe-host) running in nom-ui. */
3267
- hostVersion: string;
3268
- }
3269
-
3270
- interface UploadPayload {
3271
- buffer: ArrayBuffer;
3272
- fileName: string;
3273
- fileType: string;
3274
- entityType: string;
3275
- entityId?: string | number;
3276
- }
3277
- interface UploadResponse {
3278
- attachmentId: string;
3279
- name: string;
3280
- /** Public/presigned URL of the stored file, when the host returns one. */
3281
- url?: string;
3282
- }
3283
- interface UploadProgress {
3284
- attachmentId: string;
3285
- progress: number;
3286
- }
3287
- /** How the host should apply a navigation. Defaults to `'push'`. */
3288
- type NavigateAction = 'push' | 'replace' | 'refresh';
3289
- /** Collapse/expand the host's side navigation. */
3290
- interface SetSideNavPayload {
3291
- collapsed: boolean;
3292
- }
3293
- /** Targets for a host cache invalidation. */
3294
- interface InvalidateCachePayload {
3295
- /** API path prefixes to invalidate, e.g. `['/accounting/accounts']`. */
3296
- paths?: string[];
3297
- /** Cache tag keys to invalidate, e.g. `['REPORTS', 'SUBSIDIARIES']`. */
3298
- tags?: string[];
3299
- }
3300
- /** Result of a host cache invalidation. */
3301
- interface InvalidateResult {
3302
- invalidated: boolean;
3303
- }
3304
-
3305
- /**
3306
- * All operations the iframe can invoke on the host, each with a typed request
3307
- * payload and a typed response. Adding a new operation here is all that's
3308
- * required — message union types and handler types are derived automatically.
3309
- *
3310
- * Operations that also emit intermediate progress events should include a
3311
- * `progress` field with the progress payload type.
3312
- */
3313
- interface RequestRegistry {
3314
- GET_CHART_OF_ACCOUNTS: {
3315
- payload: Omit<GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetData, 'url'>;
3316
- data: GetCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGetResponse;
3317
- };
3318
- GET_SUBSIDIARIES: {
3319
- payload: Omit<GetAllSubsidiariesApiTenancySubsidiaryGetData, 'url'>;
3320
- data: GetAllSubsidiariesApiTenancySubsidiaryGetResponse;
3321
- };
3322
- GET_PERIODS: {
3323
- payload: Omit<GetPeriodInstancesApiActivityPeriodInstanceGetData, 'url'>;
3324
- data: unknown;
3325
- };
3326
- POST_TASK_OUTPUT: {
3327
- payload: Omit<UpdateTaskInstanceApiActivityTaskInstanceTaskInstanceIdPutData, 'url'>;
3328
- data: unknown;
3329
- };
3330
- GET_DIMENSIONS: {
3331
- payload: Omit<GetDimensionsApiAccountingDimensionGetData, 'url'>;
3332
- data: GetDimensionsApiAccountingDimensionGetResponse;
3333
- };
3334
- GET_DIMENSION_VALUES: {
3335
- payload: Omit<GetDimensionValuesApiAccountingDimensionValueGetData, 'url'>;
3336
- data: GetDimensionValuesApiAccountingDimensionValueGetResponse;
3337
- };
3338
- GET_JOURNAL_ENTRIES: {
3339
- payload: Omit<GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetData, 'url'>;
3340
- data: GetSubsidiaryJournalApiAccountingSubsidiarySubsidiaryIdJournalEntryGetResponse;
3341
- };
3342
- GET_ACTIVITY_DEFINITIONS: {
3343
- payload: Omit<GetActivityDefinitionsApiActivityActivityDefinitionGetData, 'url'>;
3344
- data: unknown;
3345
- };
3346
- GET_TASK_DEFINITIONS: {
3347
- payload: Omit<GetAllTasksDefinitionsApiActivityTaskDefinitionGetData, 'url'>;
3348
- data: GetAllTasksDefinitionsApiActivityTaskDefinitionGetResponse;
3349
- };
3350
- GET_TASK_INSTANCES: {
3351
- payload: Omit<GetAllTaskInstancesApiActivityTaskInstanceGetData, 'url'>;
3352
- data: unknown;
3353
- };
3354
- GET_FISCAL_CALENDARS: {
3355
- payload: Omit<GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetData, 'url'>;
3356
- data: GetFiscalCalendarsBySubsidiaryApiPeriodManagerFiscalCalendarBySubsidiarySubsidiaryIdGetResponse;
3357
- };
3358
- GET_FISCAL_CALENDAR: {
3359
- payload: Omit<GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetData, 'url'>;
3360
- data: GetFiscalCalendarByIdApiPeriodManagerFiscalCalendarCalendarIdGetResponse;
3361
- };
3362
- GET_ACCOUNTS: {
3363
- payload: Omit<GetAccountsApiAccountingAccountGetData, 'url'>;
3364
- data: GetAccountsApiAccountingAccountGetResponse;
3365
- };
3366
- GET_ACCOUNT: {
3367
- payload: Omit<GetAccountApiAccountingAccountAccountIdGetData, 'url'>;
3368
- data: GetAccountApiAccountingAccountAccountIdGetResponse;
3369
- };
3370
- GET_COA_TREE: {
3371
- payload: Omit<GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetData, 'url'>;
3372
- data: GetCoaTreeApiAccountingSubsidiarySubsidiaryIdCoaGetResponse;
3373
- };
3374
- GET_COA_FLAT_SIMPLE: {
3375
- payload: Omit<GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetData, 'url'>;
3376
- data: GetCoaFlatSimpleApiAccountingSubsidiarySubsidiaryIdCoaAccountSimpleGetResponse;
3377
- };
3378
- GET_COA_GROUPED: {
3379
- payload: Omit<GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetData, 'url'>;
3380
- data: GetGroupedCoaFlatApiAccountingSubsidiarySubsidiaryIdCoaAccountGroupGetResponse;
3381
- };
3382
- GET_COA_ACCOUNT: {
3383
- payload: Omit<GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetData, 'url'>;
3384
- data: GetAccountByIdApiAccountingSubsidiarySubsidiaryIdCoaAccountAccountIdGetResponse;
3385
- };
3386
- GET_SUBSIDIARY_AVAILABLE_CURRENCIES: {
3387
- payload: Omit<GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetData, 'url'>;
3388
- data: GetSubsidiaryAvailableCurrenciesApiAccountingSubsidiarySubsidiaryIdCoaAvailableCurrenciesGetResponse;
3389
- };
3390
- GET_CONVERSION_RATES: {
3391
- payload: Omit<GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetData, 'url'>;
3392
- data: GetConversionRateApiAccountingCurrencyCurrencyConversionRatesGetResponse;
3393
- };
3394
- GET_EFFECTIVE_EXCHANGE_RATE: {
3395
- payload: Omit<GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetData, 'url'>;
3396
- data: GetEffectiveExchangeRateApiAccountingConsolidationExchangeRateGetResponse;
3397
- };
3398
- GET_EXCHANGE_RATE_BY_DATE: {
3399
- payload: Omit<GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetData, 'url'>;
3400
- data: GetPeriodByDateApiAccountingConsolidationExchangeRatePeriodInputDateGetResponse;
3401
- };
3402
- GET_DIMENSION_ACCOUNT_ASSIGNMENTS: {
3403
- payload: Omit<GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetData, 'url'>;
3404
- data: GetAccountDimensionAssignmentsForDimensionApiAccountingDimensionDimensionIdAccountAccountIdGetResponse;
3405
- };
3406
- GET_DIMENSION_VALUES_HIERARCHICAL: {
3407
- payload: Omit<GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetData, 'url'>;
3408
- data: GetDimensionValuesHierarchicalApiAccountingDimensionValueHierarchicalGetResponse;
3409
- };
3410
- GET_JOURNAL_LINES: {
3411
- payload: Omit<GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetData, 'url'>;
3412
- data: GetSubsidiaryJournalLinesApiAccountingSubsidiarySubsidiaryIdJournalEntryLinesGetResponse;
3413
- };
3414
- GET_JOURNAL_ENTRY: {
3415
- payload: Omit<GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetData, 'url'>;
3416
- data: GetJournalEntryApiAccountingSubsidiarySubsidiaryIdJournalEntryJournalEntryIdGetResponse;
3417
- };
3418
- GET_PERIOD_INSTANCE: {
3419
- payload: Omit<GetPeriodInstanceApiActivityPeriodInstancePeriodInstanceIdGetData, 'url'>;
3420
- data: unknown;
3421
- };
3422
- GET_PERIOD_INSTANCE_BY_SLUG: {
3423
- payload: Omit<GetPeriodInstanceBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdGetData, 'url'>;
3424
- data: unknown;
3425
- };
3426
- GET_PERIOD_PROGRESS_BREAKDOWN: {
3427
- payload: Omit<GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetData, 'url'>;
3428
- data: GetPeriodInstanceProgressBreakdownBySlugApiActivityPeriodInstanceBySlugPeriodDisplayIdProgressBreakdownGetResponse;
3429
- };
3430
- GET_ACTIVITY_DEFINITION: {
3431
- payload: Omit<GetActivityDefinitionByIdApiActivityActivityDefinitionActivityDefinitionIdGetData, 'url'>;
3432
- data: unknown;
3433
- };
3434
- GET_ACTIVITY_INSTANCES: {
3435
- payload: Omit<GetActivityInstancesApiActivityActivityInstanceGetData, 'url'>;
3436
- data: GetActivityInstancesApiActivityActivityInstanceGetResponse;
3437
- };
3438
- GET_ACTIVITY_INSTANCE: {
3439
- payload: Omit<GetActivityInstanceApiActivityActivityInstanceActivityInstanceIdGetData, 'url'>;
3440
- data: unknown;
3441
- };
3442
- GET_ACTIVITY_INSTANCE_BY_PERIOD: {
3443
- payload: Omit<GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetData, 'url'>;
3444
- data: GetActivityInstanceByPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdGetResponse;
3445
- };
3446
- GET_ACTIVITY_INSTANCE_TASKS: {
3447
- payload: Omit<GetTaskInstancesByActivityApiActivityActivityInstanceActivityInstanceIdTaskGetData, 'url'>;
3448
- data: unknown;
3449
- };
3450
- GET_ACTIVITY_PERIOD_TASKS: {
3451
- payload: Omit<GetTaskInstancesByActivityPeriodApiActivityActivityInstanceByPeriodPeriodDisplayIdActivityDefinitionIdTaskGetData, 'url'>;
3452
- data: unknown;
3453
- };
3454
- GET_TASK_DEFINITION: {
3455
- payload: Omit<GetTaskDefinitionByIdApiActivityTaskDefinitionTaskDefinitionIdGetData, 'url'>;
3456
- data: unknown;
3457
- };
3458
- CREATE_TASK_DEFINITION: {
3459
- payload: Omit<CreateTaskDefinitionApiActivityTaskDefinitionPostData, 'url'>;
3460
- data: CreateTaskDefinitionApiActivityTaskDefinitionPostResponse;
3461
- };
3462
- UPDATE_TASK_DEFINITION: {
3463
- payload: Omit<UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutData, 'url'>;
3464
- data: UpdateTaskDefinitionApiActivityTaskDefinitionTaskDefinitionIdPutResponse;
3465
- };
3466
- GET_TASK_DEFINITIONS_BY_FILTER: {
3467
- payload: Omit<GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostData, 'url'>;
3468
- data: GetAllTasksDefinitionsByFilterApiActivityTaskDefinitionQueryPostResponse;
3469
- };
3470
- GET_TASK_INSTANCE: {
3471
- payload: Omit<GetTaskInstanceByIdApiActivityTaskInstanceTaskInstanceIdGetData, 'url'>;
3472
- data: unknown;
3473
- };
3474
- GET_TASK_INSTANCES_BY_FILTER: {
3475
- payload: Omit<GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostData, 'url'>;
3476
- data: GetAllTaskInstancesByFilterApiActivityTaskInstanceQueryPostResponse;
3477
- };
3478
- GET_AUDIT_EVENTS: {
3479
- payload: Omit<GetEventsApiAuditTrailEventGetData, 'url'>;
3480
- data: GetEventsApiAuditTrailEventGetResponse;
3481
- };
3482
- GET_ENTITY_AUDIT_EVENTS: {
3483
- payload: Omit<GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostData, 'url'>;
3484
- data: GetEntityEventsApiAuditTrailEventEntityTargetTypeTargetIdPostResponse;
3485
- };
3486
- GET_SUBSIDIARY: {
3487
- payload: Omit<GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetData, 'url'>;
3488
- data: GetSubsidiaryApiTenancySubsidiarySubsidiaryIdGetResponse;
3489
- };
3490
- GET_SUBSIDIARY_PARENT_CURRENCIES: {
3491
- payload: Omit<GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetData, 'url'>;
3492
- data: GetSubsidiaryParentCurrenciesApiTenancySubsidiarySubsidiaryIdParentCurrenciesGetResponse;
3493
- };
3494
- GET_TENANT_USERS: {
3495
- payload: Omit<GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetData, 'url'>;
3496
- data: GetTenantUsersApiTenancyTenantTenantIdOrNameUsersGetResponse;
3497
- };
3498
- INVALIDATE_CACHE: {
3499
- payload: InvalidateCachePayload;
3500
- data: InvalidateResult;
3501
- };
3502
- UPLOAD_FILE: {
3503
- payload: UploadPayload;
3504
- data: UploadResponse;
3505
- progress: UploadProgress;
3506
- };
3507
- }
3508
-
3509
- /**
3510
- * An error that crossed the bridge, carrying a machine-readable {@link code}
3511
- * alongside the human-readable message.
3512
- *
3513
- * The host attaches a `code` to failed responses (e.g. `'RATE_LIMITED'`,
3514
- * `'FILE_TOO_LARGE'`, `'REQUEST_FAILED'`); the bridge rehydrates it into a
3515
- * `BridgeError` so app `catch` blocks can branch on `error.code` instead of
3516
- * string-matching `error.message`. A failed Nominal API call rehydrates as the
3517
- * {@link HttpBridgeError} subtype, which adds the HTTP `status`.
3518
- *
3519
- * @example
3520
- * ```ts
3521
- * try {
3522
- * await bridge.getAccounts({})
3523
- * } catch (err) {
3524
- * if (err instanceof BridgeError && err.code === 'RATE_LIMITED') {
3525
- * // back off and retry
3526
- * }
3527
- * }
3528
- * ```
3529
- */
3530
- declare class BridgeError extends Error {
3531
- readonly code: string;
3532
- constructor(code: string, message: string);
3533
- }
3534
- /**
3535
- * A {@link BridgeError} for a failed Nominal API call. Its `code` is always
3536
- * `'REQUEST_FAILED'`; the HTTP {@link status} is carried as a structured field
3537
- * so callers can branch on it (e.g. `err.status === 404`) instead of parsing
3538
- * the code string.
3539
- *
3540
- * @example
3541
- * ```ts
3542
- * try {
3543
- * await bridge.getAccount({ path: { account_id: 'missing' } })
3544
- * } catch (err) {
3545
- * if (err instanceof HttpBridgeError && err.status === 404) {
3546
- * // handle not-found
3547
- * }
3548
- * }
3549
- * ```
3550
- */
3551
- declare class HttpBridgeError extends BridgeError {
3552
- readonly status: number;
3553
- constructor(status: number, message: string);
3554
- }
3555
-
3556
- interface UploadOptions {
3557
- /** Domain entity the file attaches to, e.g. `'JOURNAL_ENTRY'`. */
3558
- entityType: string;
3559
- /** Id of the entity the file attaches to, when applicable. */
3560
- entityId?: string | number;
3561
- /** Called with incremental progress (`0`–`100`) while the upload streams. */
3562
- onProgress?: (p: RequestRegistry['UPLOAD_FILE']['progress']) => void;
3563
- }
3564
- /**
3565
- * The typed Nominal data methods (~46) plus {@link BridgeDataMethods.upload},
3566
- * factored onto a base class so {@link VibeAppBridge} stays focused on
3567
- * connection/transport. Each method is a thin typed wrapper over `request()`;
3568
- * `VibeAppBridge` provides the concrete `request` implementation.
3569
- */
3570
- declare abstract class BridgeDataMethods {
3571
- /**
3572
- * Low-level typed request for **any** operation in {@link RequestRegistry} —
3573
- * implemented by {@link VibeAppBridge}. The named methods below wrap this.
3574
- */
3575
- abstract request<K extends keyof RequestRegistry>(type: K, payload: RequestRegistry[K]['payload'], onProgress?: (payload: unknown) => void): Promise<RequestRegistry[K]['data']>;
3576
- /**
3577
- * Fetch the flat chart of accounts for a subsidiary.
3578
- *
3579
- * @example
3580
- * ```ts
3581
- * const ctx = await bridge.connect()
3582
- * const accounts = await bridge.getChartOfAccounts({
3583
- * path: { subsidiary_id: ctx.subsidiaryId },
3584
- * })
3585
- * ```
3586
- */
3587
- getChartOfAccounts(payload: RequestRegistry['GET_CHART_OF_ACCOUNTS']['payload']): Promise<RequestRegistry['GET_CHART_OF_ACCOUNTS']['data']>;
3588
- /** Fetch the chart of accounts as a hierarchical tree for a subsidiary. */
3589
- getCoaTree(payload: RequestRegistry['GET_COA_TREE']['payload']): Promise<RequestRegistry['GET_COA_TREE']['data']>;
3590
- /** Fetch a simplified flat chart of accounts for a subsidiary. */
3591
- getCoaFlatSimple(payload: RequestRegistry['GET_COA_FLAT_SIMPLE']['payload']): Promise<RequestRegistry['GET_COA_FLAT_SIMPLE']['data']>;
3592
- /** Fetch the flat chart of accounts grouped by account group. */
3593
- getCoaGrouped(payload: RequestRegistry['GET_COA_GROUPED']['payload']): Promise<RequestRegistry['GET_COA_GROUPED']['data']>;
3594
- /** Fetch a single chart-of-accounts account by id within a subsidiary. */
3595
- getCoaAccount(payload: RequestRegistry['GET_COA_ACCOUNT']['payload']): Promise<RequestRegistry['GET_COA_ACCOUNT']['data']>;
3596
- /** List the currencies available to a subsidiary's chart of accounts. */
3597
- getSubsidiaryAvailableCurrencies(payload: RequestRegistry['GET_SUBSIDIARY_AVAILABLE_CURRENCIES']['payload']): Promise<RequestRegistry['GET_SUBSIDIARY_AVAILABLE_CURRENCIES']['data']>;
3598
- /** Fetch accounts at the tenant level. */
3599
- getAccounts(payload: RequestRegistry['GET_ACCOUNTS']['payload']): Promise<RequestRegistry['GET_ACCOUNTS']['data']>;
3600
- /** Fetch a single account by id. */
3601
- getAccount(payload: RequestRegistry['GET_ACCOUNT']['payload']): Promise<RequestRegistry['GET_ACCOUNT']['data']>;
3602
- /** Fetch currency conversion rates for a currency. */
3603
- getConversionRates(payload: RequestRegistry['GET_CONVERSION_RATES']['payload']): Promise<RequestRegistry['GET_CONVERSION_RATES']['data']>;
3604
- /** Fetch the effective consolidation exchange rate. */
3605
- getEffectiveExchangeRate(payload: RequestRegistry['GET_EFFECTIVE_EXCHANGE_RATE']['payload']): Promise<RequestRegistry['GET_EFFECTIVE_EXCHANGE_RATE']['data']>;
3606
- /** Fetch the exchange-rate period covering a given input date. */
3607
- getExchangeRateByDate(payload: RequestRegistry['GET_EXCHANGE_RATE_BY_DATE']['payload']): Promise<RequestRegistry['GET_EXCHANGE_RATE_BY_DATE']['data']>;
3608
- /** List accounting dimensions. */
3609
- getDimensions(payload: RequestRegistry['GET_DIMENSIONS']['payload']): Promise<RequestRegistry['GET_DIMENSIONS']['data']>;
3610
- /** List values for accounting dimensions. */
3611
- getDimensionValues(payload: RequestRegistry['GET_DIMENSION_VALUES']['payload']): Promise<RequestRegistry['GET_DIMENSION_VALUES']['data']>;
3612
- /** List dimension values in hierarchical form. */
3613
- getDimensionValuesHierarchical(payload: RequestRegistry['GET_DIMENSION_VALUES_HIERARCHICAL']['payload']): Promise<RequestRegistry['GET_DIMENSION_VALUES_HIERARCHICAL']['data']>;
3614
- /** List account assignments for a dimension/account pair. */
3615
- getDimensionAccountAssignments(payload: RequestRegistry['GET_DIMENSION_ACCOUNT_ASSIGNMENTS']['payload']): Promise<RequestRegistry['GET_DIMENSION_ACCOUNT_ASSIGNMENTS']['data']>;
3616
- /**
3617
- * Fetch journal entries for a subsidiary, optionally filtered by date range.
3618
- *
3619
- * @example
3620
- * ```ts
3621
- * const entries = await bridge.getJournalEntries({
3622
- * path: { subsidiary_id: ctx.subsidiaryId },
3623
- * query: { from_date: '2026-01-01', to_date: '2026-03-31' },
3624
- * })
3625
- * ```
3626
- */
3627
- getJournalEntries(payload: RequestRegistry['GET_JOURNAL_ENTRIES']['payload']): Promise<RequestRegistry['GET_JOURNAL_ENTRIES']['data']>;
3628
- /** Fetch journal entry lines for a subsidiary. */
3629
- getJournalLines(payload: RequestRegistry['GET_JOURNAL_LINES']['payload']): Promise<RequestRegistry['GET_JOURNAL_LINES']['data']>;
3630
- /** Fetch a single journal entry by id within a subsidiary. */
3631
- getJournalEntry(payload: RequestRegistry['GET_JOURNAL_ENTRY']['payload']): Promise<RequestRegistry['GET_JOURNAL_ENTRY']['data']>;
3632
- /** List accounting period instances. */
3633
- getPeriods(payload: RequestRegistry['GET_PERIODS']['payload']): Promise<RequestRegistry['GET_PERIODS']['data']>;
3634
- /** Fetch a single period instance by id. */
3635
- getPeriodInstance(payload: RequestRegistry['GET_PERIOD_INSTANCE']['payload']): Promise<RequestRegistry['GET_PERIOD_INSTANCE']['data']>;
3636
- /** Fetch a period instance by its display slug (e.g. `"mar-2026"`). */
3637
- getPeriodInstanceBySlug(payload: RequestRegistry['GET_PERIOD_INSTANCE_BY_SLUG']['payload']): Promise<RequestRegistry['GET_PERIOD_INSTANCE_BY_SLUG']['data']>;
3638
- /** Fetch the close-progress breakdown for a period (by slug). */
3639
- getPeriodProgressBreakdown(payload: RequestRegistry['GET_PERIOD_PROGRESS_BREAKDOWN']['payload']): Promise<RequestRegistry['GET_PERIOD_PROGRESS_BREAKDOWN']['data']>;
3640
- /** List activity definitions. */
3641
- getActivityDefinitions(payload: RequestRegistry['GET_ACTIVITY_DEFINITIONS']['payload']): Promise<RequestRegistry['GET_ACTIVITY_DEFINITIONS']['data']>;
3642
- /** Fetch a single activity definition by id. */
3643
- getActivityDefinition(payload: RequestRegistry['GET_ACTIVITY_DEFINITION']['payload']): Promise<RequestRegistry['GET_ACTIVITY_DEFINITION']['data']>;
3644
- /** List activity instances. */
3645
- getActivityInstances(payload: RequestRegistry['GET_ACTIVITY_INSTANCES']['payload']): Promise<RequestRegistry['GET_ACTIVITY_INSTANCES']['data']>;
3646
- /** Fetch a single activity instance by id. */
3647
- getActivityInstance(payload: RequestRegistry['GET_ACTIVITY_INSTANCE']['payload']): Promise<RequestRegistry['GET_ACTIVITY_INSTANCE']['data']>;
3648
- /** Fetch an activity instance for a given period + activity definition. */
3649
- getActivityInstanceByPeriod(payload: RequestRegistry['GET_ACTIVITY_INSTANCE_BY_PERIOD']['payload']): Promise<RequestRegistry['GET_ACTIVITY_INSTANCE_BY_PERIOD']['data']>;
3650
- /** List task instances for an activity instance. */
3651
- getActivityInstanceTasks(payload: RequestRegistry['GET_ACTIVITY_INSTANCE_TASKS']['payload']): Promise<RequestRegistry['GET_ACTIVITY_INSTANCE_TASKS']['data']>;
3652
- /** List task instances for an activity in a given period. */
3653
- getActivityPeriodTasks(payload: RequestRegistry['GET_ACTIVITY_PERIOD_TASKS']['payload']): Promise<RequestRegistry['GET_ACTIVITY_PERIOD_TASKS']['data']>;
3654
- /** List task definitions. */
3655
- getTaskDefinitions(payload: RequestRegistry['GET_TASK_DEFINITIONS']['payload']): Promise<RequestRegistry['GET_TASK_DEFINITIONS']['data']>;
3656
- /** Fetch a single task definition by id. */
3657
- getTaskDefinition(payload: RequestRegistry['GET_TASK_DEFINITION']['payload']): Promise<RequestRegistry['GET_TASK_DEFINITION']['data']>;
3658
- /** Create a task definition. */
3659
- createTaskDefinition(payload: RequestRegistry['CREATE_TASK_DEFINITION']['payload']): Promise<RequestRegistry['CREATE_TASK_DEFINITION']['data']>;
3660
- /** Update a task definition by id. */
3661
- updateTaskDefinition(payload: RequestRegistry['UPDATE_TASK_DEFINITION']['payload']): Promise<RequestRegistry['UPDATE_TASK_DEFINITION']['data']>;
3662
- /** Query task definitions by filter. */
3663
- getTaskDefinitionsByFilter(payload: RequestRegistry['GET_TASK_DEFINITIONS_BY_FILTER']['payload']): Promise<RequestRegistry['GET_TASK_DEFINITIONS_BY_FILTER']['data']>;
3664
- /** List task instances. */
3665
- getTaskInstances(payload: RequestRegistry['GET_TASK_INSTANCES']['payload']): Promise<RequestRegistry['GET_TASK_INSTANCES']['data']>;
3666
- /** Fetch a single task instance by id. */
3667
- getTaskInstance(payload: RequestRegistry['GET_TASK_INSTANCE']['payload']): Promise<RequestRegistry['GET_TASK_INSTANCE']['data']>;
3668
- /**
3669
- * Submit a Close-Management task output. This is the **only write path** back
3670
- * into Nominal — Vibe Apps never write Nominal data directly.
3671
- *
3672
- * @example
3673
- * ```ts
3674
- * // `body` carries the task-specific output shape.
3675
- * await bridge.postTaskOutput({
3676
- * path: { task_instance_id: 'task-1' },
3677
- * body: {},
3678
- * })
3679
- * ```
3680
- */
3681
- postTaskOutput(payload: RequestRegistry['POST_TASK_OUTPUT']['payload']): Promise<RequestRegistry['POST_TASK_OUTPUT']['data']>;
3682
- /** Query task instances by filter. */
3683
- getTaskInstancesByFilter(payload: RequestRegistry['GET_TASK_INSTANCES_BY_FILTER']['payload']): Promise<RequestRegistry['GET_TASK_INSTANCES_BY_FILTER']['data']>;
3684
- /** List audit-trail events. */
3685
- getAuditEvents(payload: RequestRegistry['GET_AUDIT_EVENTS']['payload']): Promise<RequestRegistry['GET_AUDIT_EVENTS']['data']>;
3686
- /** List audit-trail events for a specific entity. */
3687
- getEntityAuditEvents(payload: RequestRegistry['GET_ENTITY_AUDIT_EVENTS']['payload']): Promise<RequestRegistry['GET_ENTITY_AUDIT_EVENTS']['data']>;
3688
- /** List fiscal calendars for a subsidiary. */
3689
- getFiscalCalendars(payload: RequestRegistry['GET_FISCAL_CALENDARS']['payload']): Promise<RequestRegistry['GET_FISCAL_CALENDARS']['data']>;
3690
- /** Fetch a single fiscal calendar by id. */
3691
- getFiscalCalendar(payload: RequestRegistry['GET_FISCAL_CALENDAR']['payload']): Promise<RequestRegistry['GET_FISCAL_CALENDAR']['data']>;
3692
- /** List subsidiaries for the tenant. */
3693
- getSubsidiaries(payload: RequestRegistry['GET_SUBSIDIARIES']['payload']): Promise<RequestRegistry['GET_SUBSIDIARIES']['data']>;
3694
- /** Fetch a single subsidiary by id. */
3695
- getSubsidiary(payload: RequestRegistry['GET_SUBSIDIARY']['payload']): Promise<RequestRegistry['GET_SUBSIDIARY']['data']>;
3696
- /** List parent currencies for a subsidiary. */
3697
- getSubsidiaryParentCurrencies(payload: RequestRegistry['GET_SUBSIDIARY_PARENT_CURRENCIES']['payload']): Promise<RequestRegistry['GET_SUBSIDIARY_PARENT_CURRENCIES']['data']>;
3698
- /** List users for the tenant. */
3699
- getTenantUsers(payload: RequestRegistry['GET_TENANT_USERS']['payload']): Promise<RequestRegistry['GET_TENANT_USERS']['data']>;
3700
- /**
3701
- * Uploads a file through the host. Converts the `File` to an `ArrayBuffer`
3702
- * before sending — sandboxed iframes cannot pass `File` handles across
3703
- * windows. Resolves once Nominal has stored the file.
3704
- *
3705
- * @example
3706
- * ```ts
3707
- * const input = document.querySelector<HTMLInputElement>('#file')!
3708
- * const file = input.files![0]
3709
- * const result = await bridge.upload(file, {
3710
- * entityType: 'JOURNAL_ENTRY',
3711
- * entityId: '123',
3712
- * onProgress: (p) => console.log(`${p.progress}%`),
3713
- * })
3714
- * // result.attachmentId, result.name
3715
- * ```
3716
- */
3717
- upload(file: File, options: UploadOptions): Promise<RequestRegistry['UPLOAD_FILE']['data']>;
3718
- }
3719
-
3720
- interface VibeAppBridgeOptions {
3721
- /**
3722
- * Origin(s) of the Nominal app embedding this iframe. **Optional.**
3723
- *
3724
- * **Omit it** (the recommended default) and the bridge auto-detects the
3725
- * Nominal page that actually embeds it and talks only to that origin. This is
3726
- * safe because Nominal serves Vibe Apps behind a `frame-ancestors` CSP, so
3727
- * only nom-ui can frame the app — a hostile site can't embed it to intercept
3728
- * what the iframe sends out (`postTaskOutput` bodies, file uploads). Most apps
3729
- * need nothing here.
3730
- *
3731
- * Provide a value to **pin explicitly** — defense in depth, or when deploying
3732
- * outside Nominal's edge:
3733
- *
3734
- * ```ts
3735
- * parentOrigin: 'https://app.nominal.so' // one exact origin
3736
- * parentOrigin: ['https://app.nominal.so', 'https://*.vercel.app'] // exact + preview pattern
3737
- * ```
3738
- *
3739
- * A pattern's `*` matches exactly one DNS label or port — anchored, scheme
3740
- * literal — so `https://*.vercel.app` matches `https://pr-7.vercel.app` but
3741
- * not `https://a.b.vercel.app` or `https://pr-7.vercel.app.evil.com`. Patterns
3742
- * are honoured only when this app's own page is served from a recognised
3743
- * preview host (`*.vercel.app`, `*.lovable.app`, `localhost`, …); on a
3744
- * production custom domain only exact origins match.
3745
- *
3746
- * If neither an explicit value nor an auto-detected parent is available,
3747
- * `connect()` rejects with `BridgeError` code `PARENT_ORIGIN_UNRESOLVED`.
3748
- */
3749
- parentOrigin?: string | string[];
3750
- /**
3751
- * Global per-request timeout in milliseconds before a call rejects with a
3752
- * `BridgeError` whose `code` is `'TIMEOUT'`.
3753
- *
3754
- * When omitted, each operation uses an operation-specific default tuned to
3755
- * how long it realistically takes (API reads `30000`, `UPLOAD_FILE`
3756
- * `120000`, `INVALIDATE_CACHE` `10000`). Setting this overrides all of them
3757
- * with a single value — only do that if you have a specific reason; the
3758
- * defaults already match the host's expectations.
3759
- */
3760
- requestTimeout?: number;
3761
- }
3762
4
  /**
3763
5
  * Iframe-side bridge to the Nominal host. One instance per app: construct it,
3764
6
  * `await connect()` once, then call data methods, `upload()`, and subroute
3765
7
  * helpers. Tear down with `destroy()` on unmount.
3766
8
  *
9
+ * **Import- and construction-safe everywhere.** The constructor is pure — it
10
+ * stores options and touches **no** browser API — so importing this module and
11
+ * `new VibeAppBridge()` are safe during SSR, in a React Server Component, or in
12
+ * a Worker. The browser is only required when a method actually *runs*: the
13
+ * message listener, origin resolution, and history patching are all deferred to
14
+ * the first {@link VibeAppBridge.connect} (or an explicit {@link
15
+ * VibeAppBridge.attach}). Calling a browser method where there is no `window`
16
+ * throws a `BridgeError` with code `'SERVER_ENVIRONMENT'`.
17
+ *
3767
18
  * Every data method delegates to {@link VibeAppBridge.request}; the ~46 named
3768
19
  * methods (e.g. {@link VibeAppBridge.getChartOfAccounts}) are the typed,
3769
20
  * discoverable surface, and `request('<OP>', payload)` is the escape hatch for
@@ -3783,13 +34,17 @@ interface VibeAppBridgeOptions {
3783
34
  * ```
3784
35
  */
3785
36
  declare class VibeAppBridge extends BridgeDataMethods {
3786
- /** Concrete origin to `postMessage` to, or `null` if none could be resolved. */
3787
- private readonly targetOrigin;
3788
- /** Validates an inbound `event.origin` against the configured allowlist. */
3789
- private readonly isTrustedOrigin;
37
+ /** Configured origin option, read lazily at {@link attach} (never at construction). */
38
+ private readonly parentOriginOption?;
39
+ /** Concrete origin to `postMessage` to, or `null` until resolved at {@link attach}. */
40
+ private targetOrigin;
41
+ /** Validates an inbound `event.origin`; rejects everything until {@link attach}. */
42
+ private isTrustedOrigin;
3790
43
  private readonly requestTimeout;
3791
44
  private readonly pendingRequests;
3792
45
  private readonly boundHandleMessage;
46
+ /** Whether {@link attach} has installed the message listener + resolved origin. */
47
+ private attached;
3793
48
  private context;
3794
49
  /**
3795
50
  * Set once {@link initPostHog} has successfully called `posthog.init()`.
@@ -3797,6 +52,16 @@ declare class VibeAppBridge extends BridgeDataMethods {
3797
52
  * recording is actually live.
3798
53
  */
3799
54
  private posthogInitialized;
55
+ /** The lazily-imported `posthog-js` singleton, once recording is initialized. */
56
+ private posthogInstance;
57
+ /**
58
+ * Set for the duration of an in-flight {@link initPostHog} (which is async — it
59
+ * awaits `import('posthog-js')`). Serializes initialization so two overlapping
60
+ * `POSTHOG_PUSH`es can't both call `posthog.init()`.
61
+ */
62
+ private posthogIniting;
63
+ /** So the "posthog-js not installed" warning is logged at most once. */
64
+ private posthogUnavailableWarned;
3800
65
  private connectPromise;
3801
66
  private connectPollInterval;
3802
67
  private connectTimeout;
@@ -3824,25 +89,53 @@ declare class VibeAppBridge extends BridgeDataMethods {
3824
89
  private readonly kindHandlers;
3825
90
  private dispatchPush;
3826
91
  private readonly pushHandlers;
3827
- constructor({ parentOrigin, requestTimeout }?: VibeAppBridgeOptions);
92
+ /**
93
+ * Stores options only — **pure and side-effect-free**. No `window`,
94
+ * `document`, `history`, `postMessage`, `crypto`, or `posthog-js` access
95
+ * happens here, so constructing a bridge is safe during SSR / in a Server
96
+ * Component / in a Worker. Browser wiring is deferred to {@link connect} /
97
+ * {@link attach}.
98
+ */
99
+ constructor(options?: VibeAppBridgeOptions);
100
+ /**
101
+ * Installs the browser wiring: resolves the parent-origin policy and starts
102
+ * listening for host `postMessage`s. **Idempotent** and safe to call before
103
+ * {@link connect} if you want the bridge receiving pushes early; {@link
104
+ * connect} calls it for you, so most apps never call this directly.
105
+ *
106
+ * @throws `BridgeError` code `'SERVER_ENVIRONMENT'` if called where there is no
107
+ * `window`.
108
+ */
109
+ attach(): void;
110
+ /**
111
+ * Lazily installs the browser wiring on first transport use. Keeps the
112
+ * constructor pure while ensuring that any method reaching the wire (a data
113
+ * `request`, a fire-and-forget command) works without an explicit prior
114
+ * `attach()`/`connect()` — attach stays idempotent, so `connect()` is
115
+ * unaffected.
116
+ */
117
+ private ensureAttached;
3828
118
  /**
3829
119
  * Connects to the host and returns the tenant/user {@link ContextPayload}.
3830
120
  * **Call this once on app init and await it before any other method** — data
3831
121
  * methods, `upload()`, and subroute reporting all require an established
3832
122
  * connection. Concurrent calls return the same promise.
3833
123
  *
3834
- * Sends a `CONNECT` handshake, re-sending every 500ms until the host replies
3835
- * by pushing the context (so it works even if the host mounts after the
3836
- * iframe loads). Context is only ever delivered by push. Rejects with `Bridge
3837
- * connect timed out` after 10 seconds if no context arrives (usually a
3838
- * `parentOrigin` mismatch or the host hasn't mounted).
124
+ * First {@link attach | attaches} the browser wiring (message listener +
125
+ * origin resolution), then sends a `CONNECT` handshake, re-sending every 500ms
126
+ * until the host replies by pushing the context (so it works even if the host
127
+ * mounts after the iframe loads). Context is only ever delivered by push.
128
+ * Rejects with `Bridge connect timed out` after 10 seconds if no context
129
+ * arrives (usually a `parentOrigin` mismatch or the host hasn't mounted).
3839
130
  *
3840
131
  * After connecting, if the context includes an initial subroute (e.g. from
3841
132
  * a deep link), the bridge navigates to it and starts auto-tracking
3842
133
  * internal navigation via the history API.
3843
134
  *
3844
135
  * @returns The tenant/user/subsidiary context for this app session.
3845
- * @throws If no context is received within 10 seconds.
136
+ * @throws Rejects with `BridgeError` code `'SERVER_ENVIRONMENT'` if called
137
+ * where there is no `window`, `'PARENT_ORIGIN_UNRESOLVED'` if no embedding
138
+ * origin could be resolved, or `'TIMEOUT'` if no context arrives in 10s.
3846
139
  * @example
3847
140
  * ```ts
3848
141
  * const ctx = await bridge.connect()
@@ -3863,6 +156,8 @@ declare class VibeAppBridge extends BridgeDataMethods {
3863
156
  * If no callback is registered, the SDK uses `history.pushState` + a
3864
157
  * `popstate` event, which works for most SPA routers automatically.
3865
158
  * Returns an unsubscribe function.
159
+ *
160
+ * Pure — only stores the callback, so it is safe to call before {@link connect}.
3866
161
  */
3867
162
  onSubrouteRequest(callback: (subroute: string) => void): () => void;
3868
163
  /**
@@ -3872,6 +167,8 @@ declare class VibeAppBridge extends BridgeDataMethods {
3872
167
  * returns. Returns an unsubscribe function. Single subscriber: a second call
3873
168
  * replaces the first. Wire it **before {@link connect}** (the bridge warns at
3874
169
  * connect if it isn't).
170
+ *
171
+ * Pure — only stores the callback, so it is safe to call before {@link connect}.
3875
172
  */
3876
173
  onContextChange(callback: (ctx: ContextPayload) => void): () => void;
3877
174
  /**
@@ -3883,7 +180,7 @@ declare class VibeAppBridge extends BridgeDataMethods {
3883
180
  *
3884
181
  * **Wire this before {@link connect}** — without it the embedded app won't
3885
182
  * sign out when the user logs out of Nominal (the bridge warns at connect if
3886
- * it isn't wired).
183
+ * it isn't wired). Pure — only stores the callback.
3887
184
  */
3888
185
  onAuthChange(callback: (auth: AuthPayload) => void): () => void;
3889
186
  /**
@@ -3950,8 +247,9 @@ declare class VibeAppBridge extends BridgeDataMethods {
3950
247
  *
3951
248
  * **No-op until {@link connect} has resolved with PostHog enabled by the
3952
249
  * host** — if the host didn't send a `posthog` block (older host, or recording
3953
- * disabled for this env/app), nothing is sent. App authors don't import
3954
- * `posthog-js` themselves; this is the supported event surface.
250
+ * disabled for this env/app), or `posthog-js` isn't installed (it is an
251
+ * optional dependency), nothing is sent. App authors don't import `posthog-js`
252
+ * themselves; this is the supported event surface.
3955
253
  *
3956
254
  * The event is sent **directly** from the iframe's own PostHog instance (only
3957
255
  * the session *recording* is forwarded to the parent), so it carries the
@@ -3968,27 +266,39 @@ declare class VibeAppBridge extends BridgeDataMethods {
3968
266
  * ```
3969
267
  */
3970
268
  track(event: string, properties?: Record<string, unknown>): void;
269
+ /**
270
+ * Tears down the bridge: stops the connect handshake, removes the message
271
+ * listener, restores patched history methods, and rejects any in-flight calls
272
+ * with a `'DESTROYED'` error. **Idempotent and safe on the server** — calling
273
+ * it when {@link connect}/{@link attach} never ran (or where there is no
274
+ * `window`) is a no-op, so it is safe as a React effect cleanup.
275
+ */
3971
276
  destroy(): void;
3972
277
  private stopConnectPolling;
278
+ private warnPosthogUnavailable;
3973
279
  /**
3974
280
  * Initializes PostHog session recording + analytics from the host-supplied
3975
281
  * config carried by a one-time `POSTHOG_PUSH`, **only when the host opted in**
3976
282
  * (`config.enabled`).
3977
283
  *
284
+ * `posthog-js` is an **optional dependency**, loaded lazily via `await
285
+ * import('posthog-js')` the first time recording is enabled — so it stays out
286
+ * of the import graph (and out of any server bundle) for apps that never
287
+ * record. If it isn't installed, this warns once and no-ops (never throws).
288
+ *
3978
289
  * The host is the single source of truth: when it sends no `POSTHOG_PUSH`
3979
290
  * (recording disabled for this env/app) or `enabled: false`, this does
3980
- * nothing — `enabled` is the kill-switch even though `posthog-js` is bundled
3981
- * into the bridge. Cross-origin replay needs `recordCrossOriginIframes` on both
3982
- * sides so the parent receives the iframe's rrweb frames into one stitched
3983
- * recording, and `identify()` ties the iframe's recording + events to the same
3984
- * person as the host. Idempotent (the `posthogInitialized` guard) and wrapped
3985
- * in try/catch so a duplicate push or a PostHog failure is harmless.
291
+ * nothing. Cross-origin replay needs `recordCrossOriginIframes` on both sides
292
+ * so the parent receives the iframe's rrweb frames into one stitched recording,
293
+ * and `identify()` ties the iframe's recording + events to the same person as
294
+ * the host. Idempotent (the `posthogInitialized` guard) and wrapped in
295
+ * try/catch so a duplicate push or a PostHog failure is harmless.
3986
296
  */
3987
297
  private initPostHog;
3988
298
  /**
3989
299
  * Monkey-patches `history.pushState` and `history.replaceState` to
3990
300
  * auto-detect SPA navigation and report it to the host. Called after
3991
- * connect() resolves.
301
+ * connect() resolves (so `window`/`history` are guaranteed present).
3992
302
  */
3993
303
  private setupNavigationTracking;
3994
304
  private teardownNavigationTracking;
@@ -4003,6 +313,8 @@ declare class VibeAppBridge extends BridgeDataMethods {
4003
313
  * `onProgress` callback. `type` autocompletes to every operation name and
4004
314
  * narrows `payload`/return to that operation's types.
4005
315
  *
316
+ * @throws Rejects with `BridgeError` code `'SERVER_ENVIRONMENT'` if called
317
+ * where there is no `window`.
4006
318
  * @example
4007
319
  * ```ts
4008
320
  * const accounts = await bridge.request('GET_ACCOUNTS', { query: { account_ids: ['acc-1'] } })
@@ -4020,4 +332,4 @@ declare class VibeAppBridge extends BridgeDataMethods {
4020
332
  private handleProgress;
4021
333
  }
4022
334
 
4023
- export { version as BRIDGE_VERSION, BridgeError, type BridgeSubsidiary, type ContextPayload, HttpBridgeError, type InvalidateCachePayload, type InvalidateResult, type NavigateAction, type PostHogContext, type RequestRegistry, type SetSideNavPayload, type UploadOptions, type UploadProgress, type UploadResponse, VibeAppBridge, type VibeAppBridgeOptions };
335
+ export { AuthPayload, ContextPayload, InvalidateCachePayload, InvalidateResult, NavigateAction, RequestRegistry, SetSideNavPayload, VibeAppBridge, VibeAppBridgeOptions };