@firela/api-types 0.0.0-canary.92e8f8e1 → 0.0.0-canary.9b21c9cd

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.
@@ -327,15 +327,27 @@ export type AccountStandardResponseDto = {
327
327
  */
328
328
  type: 'Assets' | 'Liabilities' | 'Income' | 'Expenses' | 'Equity';
329
329
  /**
330
- * Short localized display name
330
+ * Short display name. Universal rows project to the request locale (Accept-Language); regional rows keep the authored native name — mixed-language by design (ADR-0131 class P vs class A).
331
331
  */
332
332
  name?: string;
333
333
  /**
334
- * Account description (stable semantics only)
334
+ * Authored market-language alternative names delivered verbatim (not localized copy, not xlf-managed, not locale-projected). Flat string[] per ADR-0129 D1; ADR-0131 class A.
335
+ */
336
+ aliases?: Array<string>;
337
+ /**
338
+ * Locale-projected search synonyms (e.g. the zh bank-card / debit-card everyday terms for the checking account). Pure-locale projection — absent when the locale has no seeded synonyms; English fallback rides the authored aliases field. Search-only vocabulary, not the NLP routing corpus (#698, ADR-0131 fourth-class adjudication).
339
+ */
340
+ searchTerms?: Array<string>;
341
+ /**
342
+ * Product denomination as a 3-letter ISO 4217 code, authored market data delivered verbatim (not localized, not xlf-managed). ADR-0131 class A. Absent = single-currency not asserted — consumers fall back to their own region currency (#714).
343
+ */
344
+ currency?: string;
345
+ /**
346
+ * Account description (stable semantics only). Mixed-language contract: universal rows project to the request locale via the accountDesc xlf axis with an en fallback (ADR-0131 class P, ADR-0132; unseeded locales falling back to English are expected); regional rows deliver the authored market language (ADR-0131 class A, verbatim, never xlf-managed).
335
347
  */
336
348
  description: string;
337
349
  /**
338
- * Account tags for categorization
350
+ * Account tags for categorization — structured metadata delivered verbatim (not localized, not xlf-managed). ADR-0131 class A.
339
351
  */
340
352
  tags: Array<string>;
341
353
  /**
@@ -595,7 +607,7 @@ export type PostingResponseDto = {
595
607
  */
596
608
  account: string;
597
609
  /**
598
- * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
610
+ * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned. Carries the raw Beancount sign (credit-normal accounts such as Income post negative — the accounting truth, ADR-0126); renderers must not infer economic semantics from this sign.
599
611
  */
600
612
  units?: string;
601
613
  /**
@@ -830,7 +842,7 @@ export type PostingDetailDto = {
830
842
  */
831
843
  account: string;
832
844
  /**
833
- * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
845
+ * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned. Carries the raw Beancount sign (credit-normal accounts such as Income post negative — the accounting truth, ADR-0126); renderers must not infer economic semantics from this sign.
834
846
  */
835
847
  units?: string;
836
848
  /**
@@ -976,6 +988,101 @@ export type flag2 =
976
988
  */
977
989
  export type status2 = 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
978
990
 
991
+ export type TransactionListItemDto = {
992
+ /**
993
+ * Transaction ID
994
+ */
995
+ id: string;
996
+ /**
997
+ * Transaction date
998
+ */
999
+ date: string;
1000
+ /**
1001
+ * Transaction flag
1002
+ */
1003
+ flag?:
1004
+ | 'CLEARED'
1005
+ | 'PENDING'
1006
+ | 'PADDING'
1007
+ | 'SUMMARIZE'
1008
+ | 'TRANSFER'
1009
+ | 'CONVERSIONS';
1010
+ /**
1011
+ * Custom flag (if not using standard flags)
1012
+ */
1013
+ customFlag?: string;
1014
+ /**
1015
+ * Payee name
1016
+ */
1017
+ payee?: string;
1018
+ /**
1019
+ * Transaction narration
1020
+ */
1021
+ narration: string;
1022
+ /**
1023
+ * Transaction tags
1024
+ */
1025
+ tags: Array<string>;
1026
+ /**
1027
+ * Transaction links
1028
+ */
1029
+ links: Array<string>;
1030
+ /**
1031
+ * Transaction metadata
1032
+ */
1033
+ meta?: {
1034
+ [key: string]: unknown;
1035
+ };
1036
+ /**
1037
+ * Transaction status
1038
+ */
1039
+ status: 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
1040
+ /**
1041
+ * Source type (free-form string from transaction metadata, e.g. import, api)
1042
+ */
1043
+ sourceType?: string;
1044
+ /**
1045
+ * Source platform (e.g., alipay, wechat)
1046
+ */
1047
+ sourcePlatform?: string;
1048
+ /**
1049
+ * Transaction postings
1050
+ */
1051
+ postings: Array<PostingDetailDto>;
1052
+ /**
1053
+ * Created at timestamp
1054
+ */
1055
+ createdAt: string;
1056
+ /**
1057
+ * Voided at timestamp (if voided)
1058
+ */
1059
+ voidedAt?: string;
1060
+ /**
1061
+ * User ID who voided this transaction
1062
+ */
1063
+ voidedBy?: string;
1064
+ /**
1065
+ * Correction reason (if voided or superseded)
1066
+ */
1067
+ correctionReason?: string;
1068
+ /**
1069
+ * ID of the transaction that supersedes this one (set when status=SUPERSEDED)
1070
+ */
1071
+ supersededBy?: string;
1072
+ /**
1073
+ * ID of the transaction this one corrected/replaced (back-link on the replacement)
1074
+ */
1075
+ originalTxn?: string;
1076
+ /**
1077
+ * Row amount under the request viewpoint (ADR-0126). Category viewpoint (category + flow): per-leg sign-normalized sum over the category account set (Income-root legs negated, Expenses-root identity) — positive under normal booking but NOT clamped (explicit negative expense legs and net-flip refund months stay negative). No viewpoint (plain list / search, no accountId): wallet money-flow net = raw-sign sum over cost-less Assets/Liabilities legs (income positive, expenses negative, transfers net ~0); color cue is the wallet sign (net < 0 = wealth-decreasing). Status-orthogonal: audit views match too (ADR-0128 amount-as-matching-key). Omitted under the account viewpoint (incl. dual) and for rows with no wallet leg.
1078
+ */
1079
+ viewpointAmount?: string;
1080
+ /**
1081
+ * Currency of viewpointAmount. A row spanning multiple currencies takes the largest-magnitude currency group (known simplification, ADR-0126).
1082
+ */
1083
+ viewpointCurrency?: string;
1084
+ };
1085
+
979
1086
  export type BalanceByCurrencyDto = {
980
1087
  /**
981
1088
  * ISO 4217 currency code
@@ -1004,7 +1111,7 @@ export type ExchangeRateWarningDto = {
1004
1111
 
1005
1112
  export type TransactionListSummaryDto = {
1006
1113
  /**
1007
- * Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.
1114
+ * Partial converted total in base currency (rated currencies only). Sign by viewpoint (ADR-0126): account viewpoint keeps the raw Beancount sign (income negative); category viewpoint is per-leg sign-normalized (Income legs negated, Expenses legs identity — positive under normal booking, not clamped). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.
1008
1115
  */
1009
1116
  totalAmount: string;
1010
1117
  /**
@@ -1021,11 +1128,32 @@ export type TransactionListSummaryDto = {
1021
1128
  warnings?: Array<ExchangeRateWarningDto>;
1022
1129
  };
1023
1130
 
1131
+ export type TransactionListViewpointDto = {
1132
+ /**
1133
+ * Viewpoint type (only category drill-down carries a viewpoint today)
1134
+ */
1135
+ type: 'category';
1136
+ /**
1137
+ * Flow root the category account set is restricted to
1138
+ */
1139
+ flow: 'income' | 'expense';
1140
+ };
1141
+
1142
+ /**
1143
+ * Viewpoint type (only category drill-down carries a viewpoint today)
1144
+ */
1145
+ export type type2 = 'category';
1146
+
1147
+ /**
1148
+ * Flow root the category account set is restricted to
1149
+ */
1150
+ export type flow = 'income' | 'expense';
1151
+
1024
1152
  export type TransactionListResponseDto = {
1025
1153
  /**
1026
1154
  * List of transactions
1027
1155
  */
1028
- data: Array<TransactionDetailDto>;
1156
+ data: Array<TransactionListItemDto>;
1029
1157
  /**
1030
1158
  * Total count of matching transactions
1031
1159
  */
@@ -1042,6 +1170,10 @@ export type TransactionListResponseDto = {
1042
1170
  * Amount summary for the full filtered set (#514). Present only when the request has a single account OR category viewpoint; omitted for search-only / plain-list / dual-perspective requests.
1043
1171
  */
1044
1172
  summary?: TransactionListSummaryDto;
1173
+ /**
1174
+ * Viewpoint metadata (ADR-0126). Present only for a single category filter (category + flow, no accountId); dual-perspective requests are viewpoint-less (raw signs, no viewpointAmount).
1175
+ */
1176
+ viewpoint?: TransactionListViewpointDto;
1045
1177
  };
1046
1178
 
1047
1179
  export type TagSuggestionDto = {
@@ -1253,7 +1385,7 @@ export type ReviewSummaryDto = {
1253
1385
  /**
1254
1386
  * Review type
1255
1387
  */
1256
- export type type2 =
1388
+ export type type3 =
1257
1389
  | 'DUPLICATE'
1258
1390
  | 'RULE_MATCH'
1259
1391
  | 'PAYEE_MATCH'
@@ -1701,7 +1833,7 @@ export type UpdatePayeeDto = {
1701
1833
  */
1702
1834
  customTags?: Array<string>;
1703
1835
  /**
1704
- * Metadata for extended information (location, notes, contact info, etc.). Will merge with existing metadata.
1836
+ * Metadata for extended information (location, notes, contact info, etc.)
1705
1837
  */
1706
1838
  meta?: {
1707
1839
  [key: string]: unknown;
@@ -2094,481 +2226,451 @@ export type UpdateCommodityDto = {
2094
2226
  };
2095
2227
  };
2096
2228
 
2097
- export type CreateBeanPriceDto = {
2229
+ export type CurrencyBalanceDto = {
2098
2230
  /**
2099
- * Currency being priced (e.g., USD, AAPL, BTC)
2231
+ * ISO 4217 currency code
2100
2232
  */
2101
2233
  currency: string;
2102
2234
  /**
2103
- * Quote currency (pricing currency, e.g., CNY, EUR)
2235
+ * Balance amount
2104
2236
  */
2105
- quoteCurrency: string;
2237
+ balance: string;
2238
+ };
2239
+
2240
+ export type TimeSeriesPointDto = {
2106
2241
  /**
2107
- * Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.
2242
+ * Date in YYYY-MM-DD format
2108
2243
  */
2109
- amount: number;
2244
+ date: string;
2110
2245
  /**
2111
- * Price date (ISO 8601 format)
2246
+ * Value at this date (in base currency)
2112
2247
  */
2113
- date: string;
2248
+ value: string;
2114
2249
  /**
2115
- * Metadata (validated by Zod schema, max field lengths enforced)
2250
+ * Change from previous point
2116
2251
  */
2117
- metadata?: {
2252
+ change?: {
2118
2253
  [key: string]: unknown;
2119
2254
  };
2120
- };
2121
-
2122
- export type PriceResponseDto = {
2123
2255
  /**
2124
- * Unique identifier
2256
+ * Total assets at this date (in base currency)
2125
2257
  */
2126
- id: string;
2258
+ assets?: string;
2127
2259
  /**
2128
- * User ID (owner of the price)
2260
+ * Total liabilities at this date (in base currency)
2129
2261
  */
2130
- userId: string;
2262
+ liabilities?: string;
2131
2263
  /**
2132
- * Currency being priced (e.g., USD, AAPL, BTC)
2264
+ * Multi-currency breakdown for this point
2133
2265
  */
2134
- currency: string;
2266
+ byCurrency?: Array<CurrencyBalanceDto>;
2267
+ };
2268
+
2269
+ export type TrendSummaryDto = {
2135
2270
  /**
2136
- * Quote currency (pricing currency, e.g., USD, CNY)
2271
+ * Value at start of period
2137
2272
  */
2138
- quoteCurrency: string;
2273
+ startValue: string;
2139
2274
  /**
2140
- * Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.
2275
+ * Value at end of period
2141
2276
  */
2142
- amount: number;
2277
+ endValue: string;
2143
2278
  /**
2144
- * Price date (ISO 8601 format). Represents the date this price was valid.
2279
+ * Total change over period
2145
2280
  */
2146
- date: string;
2281
+ totalChange: string;
2147
2282
  /**
2148
- * Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.
2283
+ * Total change percentage
2149
2284
  */
2150
- meta: {
2151
- [key: string]: unknown;
2152
- };
2285
+ totalChangePercentage: string;
2286
+ };
2287
+
2288
+ export type MultiCurrencyPointDto = {
2153
2289
  /**
2154
- * Creation timestamp
2290
+ * Date in YYYY-MM-DD format
2155
2291
  */
2156
- createdAt: string;
2292
+ date: string;
2157
2293
  /**
2158
- * Last update timestamp
2294
+ * Balances by currency
2159
2295
  */
2160
- updatedAt: string;
2296
+ byCurrency: Array<CurrencyBalanceDto>;
2161
2297
  };
2162
2298
 
2163
- export type PriceListResponseDto = {
2299
+ export type PortfolioTrendsResponseDto = {
2164
2300
  /**
2165
- * List of prices
2301
+ * Time series data points
2166
2302
  */
2167
- items: Array<PriceResponseDto>;
2303
+ series: Array<TimeSeriesPointDto>;
2168
2304
  /**
2169
- * Total number of prices
2305
+ * Period summary
2170
2306
  */
2171
- total: number;
2172
- };
2173
-
2174
- export type UpdateBeanPriceDto = {
2307
+ summary: TrendSummaryDto;
2175
2308
  /**
2176
- * Currency being priced
2309
+ * Period requested
2177
2310
  */
2178
- currency?: string;
2311
+ period: string;
2179
2312
  /**
2180
- * Quote currency (pricing currency)
2313
+ * Data granularity
2181
2314
  */
2182
- quoteCurrency?: string;
2315
+ granularity: string;
2183
2316
  /**
2184
- * Price amount (MUST be >= 0 per Beancount spec)
2317
+ * Base currency for converted values
2185
2318
  */
2186
- amount?: number;
2319
+ currency: string;
2187
2320
  /**
2188
- * Price date (ISO 8601 format)
2321
+ * Multi-currency time series (each point has currency breakdown)
2189
2322
  */
2190
- date?: string;
2323
+ byCurrency?: Array<MultiCurrencyPointDto>;
2191
2324
  /**
2192
- * Metadata
2325
+ * Exchange rate warnings
2193
2326
  */
2194
- metadata?: {
2195
- [key: string]: unknown;
2196
- };
2327
+ warnings?: Array<ExchangeRateWarningDto>;
2197
2328
  };
2198
2329
 
2199
- export type CreateRecurringRuleDto = {
2330
+ export type CashFlowPointDto = {
2200
2331
  /**
2201
- * Rule name (unique per user)
2332
+ * Month key (YYYY-MM)
2202
2333
  */
2203
- name: string;
2334
+ month: string;
2204
2335
  /**
2205
- * Icon emoji
2336
+ * Income in base currency (absolute, converted)
2206
2337
  */
2207
- icon?: string;
2338
+ income: string;
2208
2339
  /**
2209
- * Recurring frequency
2340
+ * Expense in base currency (absolute, converted)
2210
2341
  */
2211
- frequency:
2212
- | 'WEEKLY'
2213
- | 'BIWEEKLY'
2214
- | 'MONTHLY'
2215
- | 'BIMONTHLY'
2216
- | 'QUARTERLY'
2217
- | 'YEARLY'
2218
- | 'CUSTOM';
2342
+ expense: string;
2219
2343
  /**
2220
- * Expected amount (positive number)
2344
+ * netSavings = income − expense (savings positive)
2221
2345
  */
2222
- expectedAmount: number;
2346
+ netSavings: string;
2347
+ };
2348
+
2349
+ export type CashFlowTrendSummaryDto = {
2223
2350
  /**
2224
- * Expected day of month (1-31)
2351
+ * Total income across the period
2225
2352
  */
2226
- expectedDay?: number;
2353
+ totalIncome: string;
2227
2354
  /**
2228
- * Custom interval in days (required for CUSTOM frequency)
2355
+ * Total expense across the period
2229
2356
  */
2230
- customIntervalDays?: number;
2357
+ totalExpense: string;
2231
2358
  /**
2232
- * Currency code
2233
- */
2234
- currency: string;
2235
- /**
2236
- * Payee matching pattern (supports wildcards)
2359
+ * income − expense across the period
2237
2360
  */
2238
- matchPayeePattern?: string;
2361
+ totalNetSavings: string;
2239
2362
  /**
2240
- * Amount tolerance percentage (0-1)
2363
+ * totalNetSavings divided by the window length (N months, incl. zero-filled)
2241
2364
  */
2242
- matchAmountTolerance: number;
2365
+ averageMonthlyNetSavings: string;
2366
+ };
2367
+
2368
+ export type CashFlowTrendsResponseDto = {
2243
2369
  /**
2244
- * Default expense account for auto-create
2370
+ * Monthly cash-flow series (fixed N-month window, zero-filled)
2245
2371
  */
2246
- defaultExpenseAccount?: string;
2372
+ series: Array<CashFlowPointDto>;
2247
2373
  /**
2248
- * Default payment account for auto-create
2374
+ * Period totals
2249
2375
  */
2250
- defaultPaymentAccount?: string;
2376
+ summary: CashFlowTrendSummaryDto;
2251
2377
  /**
2252
- * Default payee for auto-create
2378
+ * Period requested
2253
2379
  */
2254
- defaultPayee?: string;
2380
+ period: string;
2255
2381
  /**
2256
- * Auto-create transaction when expected date arrives
2382
+ * Data granularity (v1 returns month buckets)
2257
2383
  */
2258
- autoCreate: boolean;
2384
+ granularity: string;
2259
2385
  /**
2260
- * Rule start date (ISO format)
2386
+ * Base currency for converted values
2261
2387
  */
2262
- startDate?: string;
2388
+ currency: string;
2263
2389
  /**
2264
- * Rule end date (ISO format)
2390
+ * Exchange rate warnings (e.g. missing rate for a currency)
2265
2391
  */
2266
- endDate?: string;
2392
+ warnings?: Array<ExchangeRateWarningDto>;
2267
2393
  };
2268
2394
 
2269
- /**
2270
- * Recurring frequency
2271
- */
2272
- export type frequency =
2273
- | 'WEEKLY'
2274
- | 'BIWEEKLY'
2275
- | 'MONTHLY'
2276
- | 'BIMONTHLY'
2277
- | 'QUARTERLY'
2278
- | 'YEARLY'
2279
- | 'CUSTOM';
2395
+ export type GenerateSnapshotBody = unknown;
2280
2396
 
2281
- export type RecurringRuleResponseDto = {
2282
- /**
2283
- * Rule ID
2284
- */
2285
- id: string;
2286
- /**
2287
- * User ID
2288
- */
2289
- userId: string;
2397
+ export type GenerateSnapshotResponse = unknown;
2398
+
2399
+ export type BackfillSnapshotsBody = unknown;
2400
+
2401
+ export type BackfillSnapshotsResponse = unknown;
2402
+
2403
+ export type CreateBeanPriceDto = {
2290
2404
  /**
2291
- * Rule name
2405
+ * Currency being priced (e.g., USD, AAPL, BTC)
2292
2406
  */
2293
- name: string;
2407
+ currency: string;
2294
2408
  /**
2295
- * Icon emoji
2409
+ * Quote currency (pricing currency, e.g., CNY, EUR)
2296
2410
  */
2297
- icon?: {
2298
- [key: string]: unknown;
2299
- };
2411
+ quoteCurrency: string;
2300
2412
  /**
2301
- * Recurring frequency
2413
+ * Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.
2302
2414
  */
2303
- frequency: string;
2415
+ amount: number;
2304
2416
  /**
2305
- * Expected amount
2417
+ * Price date (ISO 8601 format)
2306
2418
  */
2307
- expectedAmount: number;
2419
+ date: string;
2308
2420
  /**
2309
- * Expected day of month
2421
+ * Metadata (validated by Zod schema, max field lengths enforced)
2310
2422
  */
2311
- expectedDay?: {
2423
+ metadata?: {
2312
2424
  [key: string]: unknown;
2313
2425
  };
2426
+ };
2427
+
2428
+ export type PriceResponseDto = {
2314
2429
  /**
2315
- * Custom interval in days
2430
+ * Unique identifier
2316
2431
  */
2317
- customIntervalDays?: {
2318
- [key: string]: unknown;
2319
- };
2432
+ id: string;
2320
2433
  /**
2321
- * Currency code
2434
+ * User ID (owner of the price)
2435
+ */
2436
+ userId: string;
2437
+ /**
2438
+ * Currency being priced (e.g., USD, AAPL, BTC)
2322
2439
  */
2323
2440
  currency: string;
2324
2441
  /**
2325
- * Payee matching pattern
2442
+ * Quote currency (pricing currency, e.g., USD, CNY)
2326
2443
  */
2327
- matchPayeePattern?: {
2328
- [key: string]: unknown;
2329
- };
2444
+ quoteCurrency: string;
2330
2445
  /**
2331
- * Amount tolerance percentage
2446
+ * Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.
2332
2447
  */
2333
- matchAmountTolerance: number;
2448
+ amount: number;
2334
2449
  /**
2335
- * Default expense account
2450
+ * Price date (ISO 8601 format). Represents the date this price was valid.
2336
2451
  */
2337
- defaultExpenseAccount?: {
2338
- [key: string]: unknown;
2339
- };
2452
+ date: string;
2340
2453
  /**
2341
- * Default payment account
2454
+ * Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.
2342
2455
  */
2343
- defaultPaymentAccount?: {
2456
+ meta: {
2344
2457
  [key: string]: unknown;
2345
2458
  };
2346
2459
  /**
2347
- * Default payee
2460
+ * Creation timestamp
2348
2461
  */
2349
- defaultPayee?: {
2350
- [key: string]: unknown;
2351
- };
2462
+ createdAt: string;
2352
2463
  /**
2353
- * Whether rule is active
2464
+ * Last update timestamp
2354
2465
  */
2355
- isActive: boolean;
2466
+ updatedAt: string;
2467
+ };
2468
+
2469
+ export type PriceListResponseDto = {
2356
2470
  /**
2357
- * Rule start date (YYYY-MM-DD)
2471
+ * List of prices
2358
2472
  */
2359
- startDate: string;
2473
+ items: Array<PriceResponseDto>;
2360
2474
  /**
2361
- * Rule end date (YYYY-MM-DD)
2475
+ * Total number of prices
2362
2476
  */
2363
- endDate?: {
2364
- [key: string]: unknown;
2365
- };
2477
+ total: number;
2478
+ };
2479
+
2480
+ export type UpdateBeanPriceDto = {
2366
2481
  /**
2367
- * Auto-create transaction on expected date
2482
+ * Currency being priced
2368
2483
  */
2369
- autoCreate: boolean;
2484
+ currency?: string;
2370
2485
  /**
2371
- * Last matched occurrence date (YYYY-MM-DD)
2486
+ * Quote currency (pricing currency)
2372
2487
  */
2373
- lastOccurrence?: {
2374
- [key: string]: unknown;
2375
- };
2488
+ quoteCurrency?: string;
2376
2489
  /**
2377
- * Total matched transactions count
2490
+ * Price amount (MUST be >= 0 per Beancount spec)
2378
2491
  */
2379
- totalCount: number;
2492
+ amount?: number;
2380
2493
  /**
2381
- * Created at timestamp
2494
+ * Price date (ISO 8601 format)
2382
2495
  */
2383
- createdAt: string;
2496
+ date?: string;
2384
2497
  /**
2385
- * Updated at timestamp
2498
+ * Metadata
2386
2499
  */
2387
- updatedAt: string;
2500
+ metadata?: {
2501
+ [key: string]: unknown;
2502
+ };
2388
2503
  };
2389
2504
 
2390
- export type CreateRuleFromTransactionDto = {
2391
- /**
2392
- * Recurring frequency
2393
- */
2394
- frequency:
2395
- | 'WEEKLY'
2396
- | 'BIWEEKLY'
2397
- | 'MONTHLY'
2398
- | 'BIMONTHLY'
2399
- | 'QUARTERLY'
2400
- | 'YEARLY'
2401
- | 'CUSTOM';
2402
- /**
2403
- * Optional name override (default: transaction payee)
2404
- */
2405
- name?: string;
2505
+ export type DeleteOwnUserDto = {
2406
2506
  /**
2407
- * Optional icon emoji
2507
+ * Access token for user verification
2408
2508
  */
2409
- icon?: string;
2509
+ accessToken: string;
2410
2510
  };
2411
2511
 
2412
- export type RecurringRuleWithStatsResponseDto = {
2512
+ export type UserSettingsResponseDto = {
2413
2513
  /**
2414
- * Rule ID
2514
+ * Stored base currency choice (ISO 4217) for net-worth/report aggregation. null = user never chose; aggregates fall back to the region default at display time (#713).
2415
2515
  */
2416
- id: string;
2516
+ baseCurrency: string | null;
2517
+ };
2518
+
2519
+ export type UserResponseDto = {
2417
2520
  /**
2418
2521
  * User ID
2419
2522
  */
2420
- userId: string;
2421
- /**
2422
- * Rule name
2423
- */
2424
- name: string;
2523
+ id: string;
2425
2524
  /**
2426
- * Icon emoji
2525
+ * Assigned user role
2427
2526
  */
2428
- icon?: {
2429
- [key: string]: unknown;
2430
- };
2527
+ role: string;
2431
2528
  /**
2432
- * Recurring frequency
2529
+ * Permission strings
2433
2530
  */
2434
- frequency: string;
2531
+ permissions: Array<string>;
2435
2532
  /**
2436
- * Expected amount
2533
+ * User settings
2437
2534
  */
2438
- expectedAmount: number;
2535
+ settings: UserSettingsResponseDto;
2536
+ };
2537
+
2538
+ export type SignupDto = {
2439
2539
  /**
2440
- * Expected day of month
2540
+ * Cloudflare Turnstile verification token (optional when Turnstile disabled)
2441
2541
  */
2442
- expectedDay?: {
2443
- [key: string]: unknown;
2444
- };
2542
+ turnstileToken?: string;
2543
+ };
2544
+
2545
+ export type SignupResponseDto = {
2445
2546
  /**
2446
- * Custom interval in days
2547
+ * JWT auth token
2447
2548
  */
2448
- customIntervalDays?: {
2449
- [key: string]: unknown;
2450
- };
2549
+ authToken: string;
2451
2550
  /**
2452
- * Currency code
2551
+ * Auto-generated access token
2453
2552
  */
2454
- currency: string;
2553
+ accessToken: string;
2455
2554
  /**
2456
- * Payee matching pattern
2555
+ * Assigned user role
2457
2556
  */
2458
- matchPayeePattern?: {
2459
- [key: string]: unknown;
2460
- };
2557
+ role: 'USER' | 'ADMIN' | 'DEMO' | 'INACTIVE' | 'PAID' | 'OPS';
2558
+ };
2559
+
2560
+ /**
2561
+ * Assigned user role
2562
+ */
2563
+ export type role = 'USER' | 'ADMIN' | 'DEMO' | 'INACTIVE' | 'PAID' | 'OPS';
2564
+
2565
+ export type UpdateUserSettingDto = {
2461
2566
  /**
2462
- * Amount tolerance percentage
2567
+ * Security ID
2463
2568
  */
2464
- matchAmountTolerance: number;
2569
+ secId?: number;
2465
2570
  /**
2466
- * Default expense account
2571
+ * Annual interest rate
2467
2572
  */
2468
- defaultExpenseAccount?: {
2469
- [key: string]: unknown;
2470
- };
2573
+ annualInterestRate?: number;
2471
2574
  /**
2472
- * Default payment account
2575
+ * Currency code
2473
2576
  */
2474
- defaultPaymentAccount?: {
2475
- [key: string]: unknown;
2476
- };
2577
+ currency?: string;
2477
2578
  /**
2478
- * Default payee
2579
+ * Base currency code
2479
2580
  */
2480
- defaultPayee?: {
2481
- [key: string]: unknown;
2482
- };
2581
+ baseCurrency?: string;
2483
2582
  /**
2484
- * Whether rule is active
2583
+ * Benchmark symbol
2485
2584
  */
2486
- isActive: boolean;
2585
+ benchmark?: string;
2487
2586
  /**
2488
- * Rule start date (YYYY-MM-DD)
2587
+ * Color scheme
2489
2588
  */
2490
- startDate: string;
2589
+ colorScheme?: 'DARK' | 'LIGHT';
2491
2590
  /**
2492
- * Rule end date (YYYY-MM-DD)
2591
+ * Date range filter
2493
2592
  */
2494
- endDate?: {
2495
- [key: string]: unknown;
2496
- };
2593
+ dateRange?: string;
2497
2594
  /**
2498
- * Auto-create transaction on expected date
2595
+ * Emergency fund amount
2499
2596
  */
2500
- autoCreate: boolean;
2597
+ emergencyFund?: number;
2501
2598
  /**
2502
- * Last matched occurrence date (YYYY-MM-DD)
2599
+ * Account filter IDs
2503
2600
  */
2504
- lastOccurrence?: {
2505
- [key: string]: unknown;
2506
- };
2601
+ 'filters.accounts'?: Array<string>;
2507
2602
  /**
2508
- * Total matched transactions count
2603
+ * Asset class filters
2509
2604
  */
2510
- totalCount: number;
2605
+ 'filters.assetClasses'?: Array<string>;
2511
2606
  /**
2512
- * Created at timestamp
2607
+ * Data source filter
2513
2608
  */
2514
- createdAt: string;
2609
+ 'filters.dataSource'?: string;
2515
2610
  /**
2516
- * Updated at timestamp
2611
+ * Symbol filter
2517
2612
  */
2518
- updatedAt: string;
2613
+ 'filters.symbol'?: string;
2519
2614
  /**
2520
- * Number of pending expected transactions
2615
+ * Tag filters
2521
2616
  */
2522
- pendingCount: number;
2617
+ 'filters.tags'?: Array<string>;
2523
2618
  /**
2524
- * Number of overdue expected transactions
2619
+ * Enable experimental features
2525
2620
  */
2526
- overdueCount: number;
2621
+ isExperimentalFeatures?: boolean;
2527
2622
  /**
2528
- * Next expected date (YYYY-MM-DD)
2623
+ * Enable restricted view mode
2529
2624
  */
2530
- nextExpectedDate?: {
2531
- [key: string]: unknown;
2532
- };
2625
+ isRestrictedView?: boolean;
2533
2626
  /**
2534
- * Total amount of all matched transactions
2627
+ * Language code
2535
2628
  */
2536
- totalAmount: number;
2629
+ language?: string;
2537
2630
  /**
2538
- * Average amount per transaction
2631
+ * Locale code
2539
2632
  */
2540
- averageAmount: number;
2633
+ locale?: string;
2541
2634
  /**
2542
- * Number of matched transactions
2635
+ * Projected total amount
2543
2636
  */
2544
- transactionCount: number;
2637
+ projectedTotalAmount?: number;
2545
2638
  /**
2546
- * First matched transaction date (YYYY-MM-DD)
2639
+ * Retirement date in ISO 8601 format
2547
2640
  */
2548
- firstDate?: {
2549
- [key: string]: unknown;
2550
- };
2641
+ retirementDate?: string;
2551
2642
  /**
2552
- * Last matched transaction date (YYYY-MM-DD)
2643
+ * Savings rate percentage
2553
2644
  */
2554
- lastDate?: {
2555
- [key: string]: unknown;
2556
- };
2645
+ savingsRate?: number;
2557
2646
  /**
2558
- * Amount variance (standard deviation squared)
2647
+ * View mode
2559
2648
  */
2560
- variance: number;
2649
+ viewMode?: 'DEFAULT' | 'ZEN';
2650
+ };
2651
+
2652
+ /**
2653
+ * Color scheme
2654
+ */
2655
+ export type colorScheme = 'DARK' | 'LIGHT';
2656
+
2657
+ /**
2658
+ * View mode
2659
+ */
2660
+ export type viewMode = 'DEFAULT' | 'ZEN';
2661
+
2662
+ export type UpdatePropertyDto = {
2561
2663
  /**
2562
- * Number of upcoming expected transactions
2664
+ * Property value
2563
2665
  */
2564
- upcomingCount: number;
2666
+ value: string;
2565
2667
  };
2566
2668
 
2567
- export type UpdateRecurringRuleDto = {
2669
+ export type CreateRecurringRuleDto = {
2568
2670
  /**
2569
- * Rule name
2671
+ * Rule name (unique per user)
2570
2672
  */
2571
- name?: string;
2673
+ name: string;
2572
2674
  /**
2573
2675
  * Icon emoji
2574
2676
  */
@@ -2576,7 +2678,7 @@ export type UpdateRecurringRuleDto = {
2576
2678
  /**
2577
2679
  * Recurring frequency
2578
2680
  */
2579
- frequency?:
2681
+ frequency:
2580
2682
  | 'WEEKLY'
2581
2683
  | 'BIWEEKLY'
2582
2684
  | 'MONTHLY'
@@ -2585,15 +2687,15 @@ export type UpdateRecurringRuleDto = {
2585
2687
  | 'YEARLY'
2586
2688
  | 'CUSTOM';
2587
2689
  /**
2588
- * Expected amount
2690
+ * Expected amount (positive number)
2589
2691
  */
2590
- expectedAmount?: number;
2692
+ expectedAmount: number;
2591
2693
  /**
2592
2694
  * Expected day of month (1-31)
2593
2695
  */
2594
2696
  expectedDay?: number;
2595
2697
  /**
2596
- * Custom interval in days
2698
+ * Custom interval in days (required for CUSTOM frequency)
2597
2699
  */
2598
2700
  customIntervalDays?: number;
2599
2701
  /**
@@ -2601,111 +2703,150 @@ export type UpdateRecurringRuleDto = {
2601
2703
  */
2602
2704
  currency?: string;
2603
2705
  /**
2604
- * Payee matching pattern
2706
+ * Payee matching pattern (supports wildcards)
2605
2707
  */
2606
2708
  matchPayeePattern?: string;
2607
2709
  /**
2608
2710
  * Amount tolerance percentage (0-1)
2609
2711
  */
2610
- matchAmountTolerance?: number;
2712
+ matchAmountTolerance: number;
2611
2713
  /**
2612
- * Default expense account
2714
+ * Default expense account for auto-create
2613
2715
  */
2614
2716
  defaultExpenseAccount?: string;
2615
2717
  /**
2616
- * Default payment account
2718
+ * Default payment account for auto-create
2617
2719
  */
2618
2720
  defaultPaymentAccount?: string;
2619
2721
  /**
2620
- * Default payee
2722
+ * Default payee for auto-create
2621
2723
  */
2622
2724
  defaultPayee?: string;
2623
2725
  /**
2624
- * Auto-create transaction
2726
+ * Auto-create transaction when expected date arrives
2625
2727
  */
2626
- autoCreate?: boolean;
2728
+ autoCreate: boolean;
2627
2729
  /**
2628
- * Rule active status
2730
+ * Rule start date (ISO format)
2629
2731
  */
2630
- isActive?: boolean;
2732
+ startDate?: string;
2631
2733
  /**
2632
2734
  * Rule end date (ISO format)
2633
2735
  */
2634
2736
  endDate?: string;
2635
2737
  };
2636
2738
 
2637
- export type ExpectedTransactionRuleDto = {
2739
+ /**
2740
+ * Recurring frequency
2741
+ */
2742
+ export type frequency =
2743
+ | 'WEEKLY'
2744
+ | 'BIWEEKLY'
2745
+ | 'MONTHLY'
2746
+ | 'BIMONTHLY'
2747
+ | 'QUARTERLY'
2748
+ | 'YEARLY'
2749
+ | 'CUSTOM';
2750
+
2751
+ export type RecurringRuleResponseDto = {
2752
+ /**
2753
+ * Rule ID
2754
+ */
2755
+ id: string;
2756
+ /**
2757
+ * User ID
2758
+ */
2759
+ userId: string;
2638
2760
  /**
2639
2761
  * Rule name
2640
2762
  */
2641
2763
  name: string;
2642
2764
  /**
2643
- * Rule icon
2765
+ * Icon emoji
2644
2766
  */
2645
2767
  icon?: {
2646
2768
  [key: string]: unknown;
2647
2769
  };
2648
2770
  /**
2649
- * Rule frequency
2771
+ * Recurring frequency
2650
2772
  */
2651
2773
  frequency: string;
2652
2774
  /**
2653
- * Currency code
2775
+ * Expected amount
2654
2776
  */
2655
- currency: string;
2656
- };
2657
-
2658
- export type ExpectedTransactionResponseDto = {
2777
+ expectedAmount: number;
2659
2778
  /**
2660
- * Expected transaction ID
2779
+ * Expected day of month
2661
2780
  */
2662
- id: string;
2781
+ expectedDay?: {
2782
+ [key: string]: unknown;
2783
+ };
2663
2784
  /**
2664
- * User ID
2785
+ * Custom interval in days
2665
2786
  */
2666
- userId: string;
2787
+ customIntervalDays?: {
2788
+ [key: string]: unknown;
2789
+ };
2667
2790
  /**
2668
- * Associated rule ID
2791
+ * Currency code
2669
2792
  */
2670
- ruleId: string;
2793
+ currency: string;
2671
2794
  /**
2672
- * Expected date (YYYY-MM-DD)
2795
+ * Payee matching pattern
2673
2796
  */
2674
- expectedDate: string;
2797
+ matchPayeePattern?: {
2798
+ [key: string]: unknown;
2799
+ };
2675
2800
  /**
2676
- * Expected amount
2801
+ * Amount tolerance percentage
2677
2802
  */
2678
- expectedAmount: number;
2803
+ matchAmountTolerance: number;
2679
2804
  /**
2680
- * Status (PENDING, COMPLETED, SKIPPED)
2805
+ * Default expense account
2681
2806
  */
2682
- status: string;
2807
+ defaultExpenseAccount?: {
2808
+ [key: string]: unknown;
2809
+ };
2683
2810
  /**
2684
- * Matched transaction ID
2811
+ * Default payment account
2685
2812
  */
2686
- matchedTransactionId?: {
2813
+ defaultPaymentAccount?: {
2687
2814
  [key: string]: unknown;
2688
2815
  };
2689
2816
  /**
2690
- * Match timestamp (ISO 8601)
2817
+ * Default payee
2691
2818
  */
2692
- matchedAt?: {
2819
+ defaultPayee?: {
2693
2820
  [key: string]: unknown;
2694
2821
  };
2695
2822
  /**
2696
- * Match confidence score (0-1)
2823
+ * Whether rule is active
2697
2824
  */
2698
- matchConfidence?: {
2825
+ isActive: boolean;
2826
+ /**
2827
+ * Rule start date (YYYY-MM-DD)
2828
+ */
2829
+ startDate: string;
2830
+ /**
2831
+ * Rule end date (YYYY-MM-DD)
2832
+ */
2833
+ endDate?: {
2699
2834
  [key: string]: unknown;
2700
2835
  };
2701
2836
  /**
2702
- * Whether this expected transaction is overdue
2837
+ * Auto-create transaction on expected date
2703
2838
  */
2704
- isOverdue: boolean;
2839
+ autoCreate: boolean;
2705
2840
  /**
2706
- * Rule information
2841
+ * Last matched occurrence date (YYYY-MM-DD)
2707
2842
  */
2708
- rule: ExpectedTransactionRuleDto;
2843
+ lastOccurrence?: {
2844
+ [key: string]: unknown;
2845
+ };
2846
+ /**
2847
+ * Total matched transactions count
2848
+ */
2849
+ totalCount: number;
2709
2850
  /**
2710
2851
  * Created at timestamp
2711
2852
  */
@@ -2716,461 +2857,452 @@ export type ExpectedTransactionResponseDto = {
2716
2857
  updatedAt: string;
2717
2858
  };
2718
2859
 
2719
- export type ExpectedTransactionListResponseDto = {
2720
- items: Array<ExpectedTransactionResponseDto>;
2721
- /**
2722
- * Total count
2723
- */
2724
- total: number;
2725
- };
2726
-
2727
- export type ConfirmMatchDto = {
2860
+ export type CreateRuleFromTransactionDto = {
2728
2861
  /**
2729
- * Transaction ID to match with
2862
+ * Recurring frequency
2730
2863
  */
2731
- transactionId: string;
2732
- };
2733
-
2734
- export type EnterNowDto = {
2864
+ frequency:
2865
+ | 'WEEKLY'
2866
+ | 'BIWEEKLY'
2867
+ | 'MONTHLY'
2868
+ | 'BIMONTHLY'
2869
+ | 'QUARTERLY'
2870
+ | 'YEARLY'
2871
+ | 'CUSTOM';
2735
2872
  /**
2736
- * Override expense account (uses rule default if not provided)
2873
+ * Optional name override (default: transaction payee)
2737
2874
  */
2738
- expenseAccount?: string;
2875
+ name?: string;
2739
2876
  /**
2740
- * Override payment account (uses rule default if not provided)
2877
+ * Optional icon emoji
2741
2878
  */
2742
- paymentAccount?: string;
2879
+ icon?: string;
2880
+ };
2881
+
2882
+ export type RecurringRuleWithStatsResponseDto = {
2743
2883
  /**
2744
- * Override amount (uses expected amount if not provided)
2884
+ * Rule ID
2745
2885
  */
2746
- amount?: number;
2886
+ id: string;
2747
2887
  /**
2748
- * Override payee (uses rule default if not provided)
2888
+ * User ID
2749
2889
  */
2750
- payee?: string;
2890
+ userId: string;
2751
2891
  /**
2752
- * Optional narration
2892
+ * Rule name
2753
2893
  */
2754
- narration?: string;
2755
- };
2756
-
2757
- export type ForecastItemDto = {
2894
+ name: string;
2758
2895
  /**
2759
- * Rule name
2896
+ * Icon emoji
2760
2897
  */
2761
- rule: string;
2898
+ icon?: {
2899
+ [key: string]: unknown;
2900
+ };
2762
2901
  /**
2763
- * Rule ID
2902
+ * Recurring frequency
2764
2903
  */
2765
- ruleId: string;
2904
+ frequency: string;
2766
2905
  /**
2767
2906
  * Expected amount
2768
2907
  */
2769
- amount: number;
2908
+ expectedAmount: number;
2770
2909
  /**
2771
- * Expected date (YYYY-MM-DD)
2910
+ * Expected day of month
2772
2911
  */
2773
- date: string;
2912
+ expectedDay?: {
2913
+ [key: string]: unknown;
2914
+ };
2774
2915
  /**
2775
- * Rule icon emoji
2916
+ * Custom interval in days
2776
2917
  */
2777
- icon: string | null;
2918
+ customIntervalDays?: {
2919
+ [key: string]: unknown;
2920
+ };
2778
2921
  /**
2779
2922
  * Currency code
2780
2923
  */
2781
2924
  currency: string;
2782
- };
2783
-
2784
- export type MonthlyForecastDto = {
2785
2925
  /**
2786
- * Month (YYYY-MM)
2926
+ * Payee matching pattern
2787
2927
  */
2788
- month: string;
2928
+ matchPayeePattern?: {
2929
+ [key: string]: unknown;
2930
+ };
2789
2931
  /**
2790
- * Total expected outflow for the month
2932
+ * Amount tolerance percentage
2791
2933
  */
2792
- expectedOutflow: number;
2934
+ matchAmountTolerance: number;
2793
2935
  /**
2794
- * Number of expected transactions
2936
+ * Default expense account
2795
2937
  */
2796
- itemCount: number;
2938
+ defaultExpenseAccount?: {
2939
+ [key: string]: unknown;
2940
+ };
2797
2941
  /**
2798
- * Breakdown by currency
2942
+ * Default payment account
2799
2943
  */
2800
- byCurrency: {
2944
+ defaultPaymentAccount?: {
2801
2945
  [key: string]: unknown;
2802
2946
  };
2803
2947
  /**
2804
- * Individual forecast items
2948
+ * Default payee
2805
2949
  */
2806
- items: Array<ForecastItemDto>;
2807
- };
2808
-
2809
- export type ForecastResponseDto = {
2950
+ defaultPayee?: {
2951
+ [key: string]: unknown;
2952
+ };
2810
2953
  /**
2811
- * Monthly forecast data
2954
+ * Whether rule is active
2812
2955
  */
2813
- forecast: Array<MonthlyForecastDto>;
2956
+ isActive: boolean;
2814
2957
  /**
2815
- * Total expected outflow across all months
2958
+ * Rule start date (YYYY-MM-DD)
2816
2959
  */
2817
- totalOutflow: number;
2960
+ startDate: string;
2818
2961
  /**
2819
- * Total by currency across all months
2962
+ * Rule end date (YYYY-MM-DD)
2820
2963
  */
2821
- totalByCurrency: {
2964
+ endDate?: {
2822
2965
  [key: string]: unknown;
2823
2966
  };
2824
2967
  /**
2825
- * Number of active recurring rules included
2968
+ * Auto-create transaction on expected date
2826
2969
  */
2827
- rulesCount: number;
2970
+ autoCreate: boolean;
2828
2971
  /**
2829
- * Forecast period start date
2972
+ * Last matched occurrence date (YYYY-MM-DD)
2830
2973
  */
2831
- periodStart: string;
2974
+ lastOccurrence?: {
2975
+ [key: string]: unknown;
2976
+ };
2832
2977
  /**
2833
- * Forecast period end date
2978
+ * Total matched transactions count
2834
2979
  */
2835
- periodEnd: string;
2836
- };
2837
-
2838
- export type CurrencyBalanceDto = {
2980
+ totalCount: number;
2839
2981
  /**
2840
- * ISO 4217 currency code
2982
+ * Created at timestamp
2841
2983
  */
2842
- currency: string;
2984
+ createdAt: string;
2843
2985
  /**
2844
- * Balance amount
2986
+ * Updated at timestamp
2845
2987
  */
2846
- balance: string;
2847
- };
2848
-
2849
- export type TimeSeriesPointDto = {
2988
+ updatedAt: string;
2850
2989
  /**
2851
- * Date in YYYY-MM-DD format
2990
+ * Number of pending expected transactions
2852
2991
  */
2853
- date: string;
2992
+ pendingCount: number;
2854
2993
  /**
2855
- * Value at this date (in base currency)
2994
+ * Number of overdue expected transactions
2856
2995
  */
2857
- value: string;
2996
+ overdueCount: number;
2858
2997
  /**
2859
- * Change from previous point
2998
+ * Next expected date (YYYY-MM-DD)
2860
2999
  */
2861
- change?: {
3000
+ nextExpectedDate?: {
2862
3001
  [key: string]: unknown;
2863
3002
  };
2864
3003
  /**
2865
- * Total assets at this date (in base currency)
3004
+ * Total amount of all matched transactions
2866
3005
  */
2867
- assets?: string;
3006
+ totalAmount: number;
2868
3007
  /**
2869
- * Total liabilities at this date (in base currency)
3008
+ * Average amount per transaction
2870
3009
  */
2871
- liabilities?: string;
3010
+ averageAmount: number;
2872
3011
  /**
2873
- * Multi-currency breakdown for this point
3012
+ * Number of matched transactions
2874
3013
  */
2875
- byCurrency?: Array<CurrencyBalanceDto>;
2876
- };
2877
-
2878
- export type TrendSummaryDto = {
3014
+ transactionCount: number;
2879
3015
  /**
2880
- * Value at start of period
3016
+ * First matched transaction date (YYYY-MM-DD)
2881
3017
  */
2882
- startValue: string;
3018
+ firstDate?: {
3019
+ [key: string]: unknown;
3020
+ };
2883
3021
  /**
2884
- * Value at end of period
3022
+ * Last matched transaction date (YYYY-MM-DD)
2885
3023
  */
2886
- endValue: string;
3024
+ lastDate?: {
3025
+ [key: string]: unknown;
3026
+ };
2887
3027
  /**
2888
- * Total change over period
3028
+ * Amount variance (standard deviation squared)
2889
3029
  */
2890
- totalChange: string;
3030
+ variance: number;
2891
3031
  /**
2892
- * Total change percentage
3032
+ * Number of upcoming expected transactions
2893
3033
  */
2894
- totalChangePercentage: string;
3034
+ upcomingCount: number;
2895
3035
  };
2896
3036
 
2897
- export type MultiCurrencyPointDto = {
3037
+ export type UpdateRecurringRuleDto = {
2898
3038
  /**
2899
- * Date in YYYY-MM-DD format
3039
+ * Rule name (unique per user)
2900
3040
  */
2901
- date: string;
3041
+ name?: string;
2902
3042
  /**
2903
- * Balances by currency
3043
+ * Icon emoji
2904
3044
  */
2905
- byCurrency: Array<CurrencyBalanceDto>;
2906
- };
2907
-
2908
- export type PortfolioTrendsResponseDto = {
3045
+ icon?: string;
2909
3046
  /**
2910
- * Time series data points
3047
+ * Recurring frequency
2911
3048
  */
2912
- series: Array<TimeSeriesPointDto>;
3049
+ frequency?:
3050
+ | 'WEEKLY'
3051
+ | 'BIWEEKLY'
3052
+ | 'MONTHLY'
3053
+ | 'BIMONTHLY'
3054
+ | 'QUARTERLY'
3055
+ | 'YEARLY'
3056
+ | 'CUSTOM';
2913
3057
  /**
2914
- * Period summary
3058
+ * Expected amount (positive number)
2915
3059
  */
2916
- summary: TrendSummaryDto;
3060
+ expectedAmount?: number;
2917
3061
  /**
2918
- * Period requested
3062
+ * Expected day of month (1-31)
2919
3063
  */
2920
- period: string;
3064
+ expectedDay?: number;
2921
3065
  /**
2922
- * Data granularity
3066
+ * Currency code
2923
3067
  */
2924
- granularity: string;
3068
+ currency?: string;
2925
3069
  /**
2926
- * Base currency for converted values
3070
+ * Payee matching pattern (supports wildcards)
2927
3071
  */
2928
- currency: string;
3072
+ matchPayeePattern?: string;
2929
3073
  /**
2930
- * Multi-currency time series (each point has currency breakdown)
3074
+ * Amount tolerance percentage (0-1)
2931
3075
  */
2932
- byCurrency?: Array<MultiCurrencyPointDto>;
3076
+ matchAmountTolerance?: number;
2933
3077
  /**
2934
- * Exchange rate warnings
3078
+ * Default expense account for auto-create
2935
3079
  */
2936
- warnings?: Array<ExchangeRateWarningDto>;
2937
- };
2938
-
2939
- export type CashFlowPointDto = {
3080
+ defaultExpenseAccount?: string;
2940
3081
  /**
2941
- * Month key (YYYY-MM)
3082
+ * Default payment account for auto-create
2942
3083
  */
2943
- month: string;
3084
+ defaultPaymentAccount?: string;
2944
3085
  /**
2945
- * Income in base currency (absolute, converted)
3086
+ * Default payee for auto-create
2946
3087
  */
2947
- income: string;
3088
+ defaultPayee?: string;
2948
3089
  /**
2949
- * Expense in base currency (absolute, converted)
3090
+ * Auto-create transaction when expected date arrives
2950
3091
  */
2951
- expense: string;
3092
+ autoCreate?: boolean;
2952
3093
  /**
2953
- * netSavings = income − expense (savings positive)
3094
+ * Rule end date (ISO format)
2954
3095
  */
2955
- netSavings: string;
3096
+ endDate?: string;
3097
+ /**
3098
+ * Custom interval in days
3099
+ */
3100
+ customIntervalDays?: number;
3101
+ /**
3102
+ * Rule active status
3103
+ */
3104
+ isActive?: boolean;
2956
3105
  };
2957
3106
 
2958
- export type CashFlowTrendSummaryDto = {
3107
+ export type ExpectedTransactionRuleDto = {
2959
3108
  /**
2960
- * Total income across the period
3109
+ * Rule name
2961
3110
  */
2962
- totalIncome: string;
3111
+ name: string;
2963
3112
  /**
2964
- * Total expense across the period
3113
+ * Rule icon
2965
3114
  */
2966
- totalExpense: string;
3115
+ icon?: {
3116
+ [key: string]: unknown;
3117
+ };
2967
3118
  /**
2968
- * income − expense across the period
3119
+ * Rule frequency
2969
3120
  */
2970
- totalNetSavings: string;
3121
+ frequency: string;
2971
3122
  /**
2972
- * totalNetSavings divided by the window length (N months, incl. zero-filled)
3123
+ * Currency code
2973
3124
  */
2974
- averageMonthlyNetSavings: string;
3125
+ currency: string;
2975
3126
  };
2976
3127
 
2977
- export type CashFlowTrendsResponseDto = {
3128
+ export type ExpectedTransactionResponseDto = {
2978
3129
  /**
2979
- * Monthly cash-flow series (fixed N-month window, zero-filled)
3130
+ * Expected transaction ID
2980
3131
  */
2981
- series: Array<CashFlowPointDto>;
3132
+ id: string;
2982
3133
  /**
2983
- * Period totals
3134
+ * User ID
2984
3135
  */
2985
- summary: CashFlowTrendSummaryDto;
3136
+ userId: string;
2986
3137
  /**
2987
- * Period requested
3138
+ * Associated rule ID
2988
3139
  */
2989
- period: string;
3140
+ ruleId: string;
2990
3141
  /**
2991
- * Data granularity (v1 returns month buckets)
3142
+ * Expected date (YYYY-MM-DD)
2992
3143
  */
2993
- granularity: string;
3144
+ expectedDate: string;
2994
3145
  /**
2995
- * Base currency for converted values
3146
+ * Expected amount
2996
3147
  */
2997
- currency: string;
3148
+ expectedAmount: number;
2998
3149
  /**
2999
- * Exchange rate warnings (e.g. missing rate for a currency)
3150
+ * Status (PENDING, COMPLETED, SKIPPED)
3000
3151
  */
3001
- warnings?: Array<ExchangeRateWarningDto>;
3002
- };
3003
-
3004
- export type GenerateSnapshotBody = unknown;
3005
-
3006
- export type GenerateSnapshotResponse = unknown;
3007
-
3008
- export type BackfillSnapshotsBody = unknown;
3009
-
3010
- export type BackfillSnapshotsResponse = unknown;
3011
-
3012
- export type DeleteOwnUserDto = {
3152
+ status: string;
3013
3153
  /**
3014
- * Access token for user verification
3154
+ * Matched transaction ID
3015
3155
  */
3016
- accessToken: string;
3017
- };
3018
-
3019
- export type UserSettingsResponseDto = {
3156
+ matchedTransactionId?: {
3157
+ [key: string]: unknown;
3158
+ };
3020
3159
  /**
3021
- * Base currency (ISO 4217) for net-worth/report aggregation. Independent of region (ADR-0006).
3160
+ * Match timestamp (ISO 8601)
3022
3161
  */
3023
- baseCurrency: string | null;
3024
- };
3025
-
3026
- export type UserResponseDto = {
3162
+ matchedAt?: {
3163
+ [key: string]: unknown;
3164
+ };
3027
3165
  /**
3028
- * User ID
3166
+ * Match confidence score (0-1)
3029
3167
  */
3030
- id: string;
3168
+ matchConfidence?: {
3169
+ [key: string]: unknown;
3170
+ };
3031
3171
  /**
3032
- * Assigned user role
3172
+ * Whether this expected transaction is overdue
3033
3173
  */
3034
- role: string;
3174
+ isOverdue: boolean;
3035
3175
  /**
3036
- * Permission strings
3176
+ * Rule information
3037
3177
  */
3038
- permissions: Array<string>;
3178
+ rule: ExpectedTransactionRuleDto;
3179
+ /**
3180
+ * Created at timestamp
3181
+ */
3182
+ createdAt: string;
3039
3183
  /**
3040
- * User settings
3184
+ * Updated at timestamp
3041
3185
  */
3042
- settings: UserSettingsResponseDto;
3186
+ updatedAt: string;
3043
3187
  };
3044
3188
 
3045
- export type SignupDto = {
3189
+ export type ExpectedTransactionListResponseDto = {
3190
+ items: Array<ExpectedTransactionResponseDto>;
3046
3191
  /**
3047
- * Cloudflare Turnstile verification token (optional when Turnstile disabled)
3192
+ * Total count
3048
3193
  */
3049
- turnstileToken?: string;
3194
+ total: number;
3050
3195
  };
3051
3196
 
3052
- export type SignupResponseDto = {
3053
- /**
3054
- * JWT auth token
3055
- */
3056
- authToken: string;
3057
- /**
3058
- * Auto-generated access token
3059
- */
3060
- accessToken: string;
3197
+ export type ConfirmMatchDto = {
3061
3198
  /**
3062
- * Assigned user role
3199
+ * Transaction ID to match with
3063
3200
  */
3064
- role: 'USER' | 'ADMIN' | 'DEMO' | 'INACTIVE' | 'PAID' | 'OPS';
3201
+ transactionId: string;
3065
3202
  };
3066
3203
 
3067
- /**
3068
- * Assigned user role
3069
- */
3070
- export type role = 'USER' | 'ADMIN' | 'DEMO' | 'INACTIVE' | 'PAID' | 'OPS';
3071
-
3072
- export type UpdateUserSettingDto = {
3204
+ export type EnterNowDto = {
3073
3205
  /**
3074
- * Security ID
3206
+ * Override expense account (uses rule default if not provided)
3075
3207
  */
3076
- secId?: number;
3208
+ expenseAccount?: string;
3077
3209
  /**
3078
- * Annual interest rate
3210
+ * Override payment account (uses rule default if not provided)
3079
3211
  */
3080
- annualInterestRate?: number;
3212
+ paymentAccount?: string;
3081
3213
  /**
3082
- * Currency code
3214
+ * Override amount (uses expected amount if not provided)
3083
3215
  */
3084
- currency?: string;
3216
+ amount?: number;
3085
3217
  /**
3086
- * Base currency code
3218
+ * Override payee (uses rule default if not provided)
3087
3219
  */
3088
- baseCurrency?: string;
3220
+ payee?: string;
3089
3221
  /**
3090
- * Benchmark symbol
3222
+ * Optional narration
3091
3223
  */
3092
- benchmark?: string;
3224
+ narration?: string;
3225
+ };
3226
+
3227
+ export type ForecastItemDto = {
3093
3228
  /**
3094
- * Color scheme
3229
+ * Rule name
3095
3230
  */
3096
- colorScheme?: 'DARK' | 'LIGHT';
3231
+ rule: string;
3097
3232
  /**
3098
- * Date range filter
3233
+ * Rule ID
3099
3234
  */
3100
- dateRange?: string;
3235
+ ruleId: string;
3101
3236
  /**
3102
- * Emergency fund amount
3237
+ * Expected amount
3103
3238
  */
3104
- emergencyFund?: number;
3239
+ amount: number;
3105
3240
  /**
3106
- * Account filter IDs
3241
+ * Expected date (YYYY-MM-DD)
3107
3242
  */
3108
- 'filters.accounts'?: Array<string>;
3243
+ date: string;
3109
3244
  /**
3110
- * Asset class filters
3245
+ * Rule icon emoji
3111
3246
  */
3112
- 'filters.assetClasses'?: Array<string>;
3247
+ icon: string | null;
3113
3248
  /**
3114
- * Data source filter
3249
+ * Currency code
3115
3250
  */
3116
- 'filters.dataSource'?: string;
3251
+ currency: string;
3252
+ };
3253
+
3254
+ export type MonthlyForecastDto = {
3117
3255
  /**
3118
- * Symbol filter
3256
+ * Month (YYYY-MM)
3119
3257
  */
3120
- 'filters.symbol'?: string;
3258
+ month: string;
3121
3259
  /**
3122
- * Tag filters
3260
+ * Total expected outflow for the month
3123
3261
  */
3124
- 'filters.tags'?: Array<string>;
3262
+ expectedOutflow: number;
3125
3263
  /**
3126
- * Enable experimental features
3264
+ * Number of expected transactions
3127
3265
  */
3128
- isExperimentalFeatures?: boolean;
3266
+ itemCount: number;
3129
3267
  /**
3130
- * Enable restricted view mode
3268
+ * Breakdown by currency
3131
3269
  */
3132
- isRestrictedView?: boolean;
3270
+ byCurrency: {
3271
+ [key: string]: unknown;
3272
+ };
3133
3273
  /**
3134
- * Language code
3274
+ * Individual forecast items
3135
3275
  */
3136
- language?: string;
3276
+ items: Array<ForecastItemDto>;
3277
+ };
3278
+
3279
+ export type ForecastResponseDto = {
3137
3280
  /**
3138
- * Locale code
3281
+ * Monthly forecast data
3139
3282
  */
3140
- locale?: string;
3283
+ forecast: Array<MonthlyForecastDto>;
3141
3284
  /**
3142
- * Projected total amount
3285
+ * Total expected outflow across all months
3143
3286
  */
3144
- projectedTotalAmount?: number;
3287
+ totalOutflow: number;
3145
3288
  /**
3146
- * Retirement date in ISO 8601 format
3289
+ * Total by currency across all months
3147
3290
  */
3148
- retirementDate?: string;
3291
+ totalByCurrency: {
3292
+ [key: string]: unknown;
3293
+ };
3149
3294
  /**
3150
- * Savings rate percentage
3295
+ * Number of active recurring rules included
3151
3296
  */
3152
- savingsRate?: number;
3297
+ rulesCount: number;
3153
3298
  /**
3154
- * View mode
3299
+ * Forecast period start date
3155
3300
  */
3156
- viewMode?: 'DEFAULT' | 'ZEN';
3157
- };
3158
-
3159
- /**
3160
- * Color scheme
3161
- */
3162
- export type colorScheme = 'DARK' | 'LIGHT';
3163
-
3164
- /**
3165
- * View mode
3166
- */
3167
- export type viewMode = 'DEFAULT' | 'ZEN';
3168
-
3169
- export type UpdatePropertyDto = {
3301
+ periodStart: string;
3170
3302
  /**
3171
- * Property value
3303
+ * Forecast period end date
3172
3304
  */
3173
- value: string;
3305
+ periodEnd: string;
3174
3306
  };
3175
3307
 
3176
3308
  export type CreateTransactionRuleDto = {
@@ -3489,14 +3621,14 @@ export type UpdateTransactionRuleDto = {
3489
3621
  */
3490
3622
  amountMax?: number;
3491
3623
  priority?: number;
3492
- /**
3493
- * Enable or disable the rule
3494
- */
3495
- enabled?: boolean;
3496
3624
  additionalTags?: Array<unknown[]>;
3497
3625
  additionalMetadata?: {
3498
3626
  [key: string]: unknown;
3499
3627
  };
3628
+ /**
3629
+ * Enable or disable the rule
3630
+ */
3631
+ enabled?: boolean;
3500
3632
  };
3501
3633
 
3502
3634
  export type TestRuleDto = {
@@ -4355,11 +4487,28 @@ export type ProcessNlpDto = {
4355
4487
  */
4356
4488
  selectedRuleId?: string;
4357
4489
  /**
4358
- * confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i], or a typed path). Applied directly when the session is confirming_account — no NL re-parse.
4490
+ * confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i].path, or a typed path). Applied directly when the session is confirming_account — no NL re-parse.
4359
4491
  */
4360
4492
  selectedAccount?: string;
4493
+ /**
4494
+ * Viewpoint account hint: the beancount path the user drilled into (e.g. from an account drill-down). Tie-break only — never overrides accounts resolved from the text. Must be an owned, OPEN Assets:/Liabilities: account; unresolvable hints are silently ignored.
4495
+ */
4496
+ viewpointAccount?: string;
4497
+ /**
4498
+ * Viewpoint category hint: the ADR-0075 Group segment the user drilled into (e.g. 'Food'). Resolved to a concrete OPEN account in that group; tie-break only — never overrides a category resolved from the text.
4499
+ */
4500
+ viewpointCategory?: string;
4501
+ /**
4502
+ * Companion flow root for viewpointCategory ('income' | 'expense'), mirroring the ADR-0126 list-endpoint invariant. Derived from the session's routed intent (multi-turn) when absent; a first-turn flow-less category hint is dropped — send the flow explicitly.
4503
+ */
4504
+ viewpointFlow?: 'income' | 'expense';
4361
4505
  };
4362
4506
 
4507
+ /**
4508
+ * Companion flow root for viewpointCategory ('income' | 'expense'), mirroring the ADR-0126 list-endpoint invariant. Derived from the session's routed intent (multi-turn) when absent; a first-turn flow-less category hint is dropped — send the flow explicitly.
4509
+ */
4510
+ export type viewpointFlow = 'income' | 'expense';
4511
+
4363
4512
  export type NlpTransactionInfoDto = {
4364
4513
  /**
4365
4514
  * Transaction ID
@@ -4585,6 +4734,17 @@ export type NlpRuleConfirmationDataDto = {
4585
4734
  reasons: Array<string>;
4586
4735
  };
4587
4736
 
4737
+ export type NlpAccountCandidateDto = {
4738
+ /**
4739
+ * Canonical beancount account path (echo back on selection)
4740
+ */
4741
+ path: string;
4742
+ /**
4743
+ * Localized display name (ADR-0114 read-time projection, user locale)
4744
+ */
4745
+ name: string;
4746
+ };
4747
+
4588
4748
  export type NlpAccountConfirmationDataDto = {
4589
4749
  /**
4590
4750
  * The invalid account name
@@ -4595,9 +4755,9 @@ export type NlpAccountConfirmationDataDto = {
4595
4755
  */
4596
4756
  suggestedAccount?: string;
4597
4757
  /**
4598
- * Similar accounts for user selection
4758
+ * Similar accounts for user selection (path + localized name, #680)
4599
4759
  */
4600
- similarAccounts: Array<string>;
4760
+ similarAccounts: Array<NlpAccountCandidateDto>;
4601
4761
  /**
4602
4762
  * Error message explaining the issue
4603
4763
  */
@@ -4781,7 +4941,12 @@ export type NlpResponseDto = {
4781
4941
  /**
4782
4942
  * Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.
4783
4943
  */
4784
- assetSubType?: 'transfer' | 'banking' | 'investment';
4944
+ assetSubType?:
4945
+ | 'transfer'
4946
+ | 'banking'
4947
+ | 'investment'
4948
+ | 'lend'
4949
+ | 'lend_collect';
4785
4950
  /**
4786
4951
  * Liability sub-type (only present when intent is "liability"). borrow: borrowing money (Liabilities → Assets), repay: repaying debt (Assets → Liabilities).
4787
4952
  */
@@ -4898,7 +5063,12 @@ export type intent = 'expense' | 'asset' | 'income' | 'liability' | 'equity';
4898
5063
  /**
4899
5064
  * Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.
4900
5065
  */
4901
- export type assetSubType = 'transfer' | 'banking' | 'investment';
5066
+ export type assetSubType =
5067
+ | 'transfer'
5068
+ | 'banking'
5069
+ | 'investment'
5070
+ | 'lend'
5071
+ | 'lend_collect';
4902
5072
 
4903
5073
  /**
4904
5074
  * Liability sub-type (only present when intent is "liability"). borrow: borrowing money (Liabilities → Assets), repay: repaying debt (Assets → Liabilities).
@@ -4963,7 +5133,7 @@ export type PlatformListItemDto = {
4963
5133
  /**
4964
5134
  * Platform type
4965
5135
  */
4966
- export type type3 =
5136
+ export type type4 =
4967
5137
  | 'BANK'
4968
5138
  | 'BROKERAGE'
4969
5139
  | 'CRYPTO_EXCHANGE'
@@ -4997,56 +5167,105 @@ export type PlatformMatchResultDto = {
4997
5167
  | 'INSURANCE'
4998
5168
  | 'OTHER';
4999
5169
  /**
5000
- * Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")
5001
- */
5002
- suggestedSegment: string;
5003
- /**
5004
- * Logo URL
5005
- */
5006
- logoUrl: string | null;
5007
- /**
5008
- * ISO 3166-1 alpha-2 (UPPERCASE); null = global platform
5009
- */
5010
- countryCode: string | null;
5011
- /**
5012
- * Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.
5170
+ * Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")
5171
+ */
5172
+ suggestedSegment: string;
5173
+ /**
5174
+ * Logo URL
5175
+ */
5176
+ logoUrl: string | null;
5177
+ /**
5178
+ * ISO 3166-1 alpha-2 (UPPERCASE); null = global platform
5179
+ */
5180
+ countryCode: string | null;
5181
+ /**
5182
+ * Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.
5183
+ */
5184
+ category: string | null;
5185
+ /**
5186
+ * How this row matched: 'exact' > 'prefix' > 'substring'
5187
+ */
5188
+ matchType: 'exact' | 'prefix' | 'substring';
5189
+ };
5190
+
5191
+ /**
5192
+ * How this row matched: 'exact' > 'prefix' > 'substring'
5193
+ */
5194
+ export type matchType = 'exact' | 'prefix' | 'substring';
5195
+
5196
+ export type PlatformMatchResponseDto = {
5197
+ /**
5198
+ * Ranked matches, best tier first (at most 10 rows)
5199
+ */
5200
+ platforms: Array<PlatformMatchResultDto>;
5201
+ /**
5202
+ * Overall match quality — top row's tier, or 'none' when no hits
5203
+ */
5204
+ matchType: 'none' | 'exact' | 'prefix' | 'substring';
5205
+ /**
5206
+ * Total matches before LIMIT (truncation transparency)
5207
+ */
5208
+ total: number;
5209
+ /**
5210
+ * true when total > platforms.length (more matches exist)
5211
+ */
5212
+ hasMore: boolean;
5213
+ };
5214
+
5215
+ /**
5216
+ * Overall match quality — top row's tier, or 'none' when no hits
5217
+ */
5218
+ export type matchType2 = 'none' | 'exact' | 'prefix' | 'substring';
5219
+
5220
+ export type PlatformStandardsPlatformDto = {
5221
+ /**
5222
+ * Global platform ID
5223
+ */
5224
+ id: string;
5225
+ /**
5226
+ * Platform name (e.g., "ICBC")
5227
+ */
5228
+ name: string;
5229
+ /**
5230
+ * Canonical identifier in ACCOUNT_RE format (e.g., "icbc")
5231
+ */
5232
+ canonical: string;
5233
+ /**
5234
+ * Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")
5235
+ */
5236
+ suggestedSegment: string;
5237
+ /**
5238
+ * Platform type
5239
+ */
5240
+ type:
5241
+ | 'BANK'
5242
+ | 'BROKERAGE'
5243
+ | 'CRYPTO_EXCHANGE'
5244
+ | 'PAYMENT'
5245
+ | 'INVESTMENT'
5246
+ | 'INSURANCE'
5247
+ | 'OTHER';
5248
+ /**
5249
+ * Region-aware category (institution vocab, e.g. DigitalWallet/Bank) resolved against the final region. null = no region-aware suggestion; fall back to type.
5013
5250
  */
5014
5251
  category: string | null;
5015
- /**
5016
- * How this row matched: 'exact' > 'prefix' > 'substring'
5017
- */
5018
- matchType: 'exact' | 'prefix' | 'substring';
5019
5252
  };
5020
5253
 
5021
- /**
5022
- * How this row matched: 'exact' > 'prefix' > 'substring'
5023
- */
5024
- export type matchType = 'exact' | 'prefix' | 'substring';
5025
-
5026
- export type PlatformMatchResponseDto = {
5254
+ export type PlatformStandardsResponseDto = {
5027
5255
  /**
5028
- * Ranked matches, best tier first (at most 10 rows)
5029
- */
5030
- platforms: Array<PlatformMatchResultDto>;
5031
- /**
5032
- * Overall match quality — top row's tier, or 'none' when no hits
5256
+ * The selected platform (institution lock source)
5033
5257
  */
5034
- matchType: 'none' | 'exact' | 'prefix' | 'substring';
5258
+ platform: PlatformStandardsPlatformDto;
5035
5259
  /**
5036
- * Total matches before LIMIT (truncation transparency)
5260
+ * Resolved template region (ISO 3166-1 alpha-2, UPPERCASE): the platform's own countryCode when set, else the region query param. For regions without a regional template file the template list falls back to the universal-only catalog while region still echoes the code.
5037
5261
  */
5038
- total: number;
5262
+ region: string;
5039
5263
  /**
5040
- * true when total > platforms.length (more matches exist)
5264
+ * Candidate account-standard templates of the resolved region (groupable by productCategory client-side)
5041
5265
  */
5042
- hasMore: boolean;
5266
+ templates: Array<AccountStandardResponseDto>;
5043
5267
  };
5044
5268
 
5045
- /**
5046
- * Overall match quality — top row's tier, or 'none' when no hits
5047
- */
5048
- export type matchType2 = 'none' | 'exact' | 'prefix' | 'substring';
5049
-
5050
5269
  export type CreatePlatformDto = {
5051
5270
  /**
5052
5271
  * Platform name
@@ -5243,11 +5462,11 @@ export type PlatformGroupDto = {
5243
5462
  */
5244
5463
  platformName: string;
5245
5464
  /**
5246
- * Accounts within this platform
5465
+ * Accounts within this platform (Assets and Liabilities rows, #696)
5247
5466
  */
5248
5467
  accounts: Array<AccountItemDto>;
5249
5468
  /**
5250
- * FX-converted total balance in base currency
5469
+ * FX-converted total balance in base currency (nets Assets + Liabilities rows; can be negative)
5251
5470
  */
5252
5471
  totalBalance: string;
5253
5472
  /**
@@ -5259,7 +5478,7 @@ export type PlatformGroupDto = {
5259
5478
  */
5260
5479
  convertedBalance?: string;
5261
5480
  /**
5262
- * Share of the grand converted total (0-100); 0 when grand total is 0
5481
+ * Share of the converted asset-side grand total (0-100); liability balances are excluded from the basis; 0 when grand total is 0 (#696)
5263
5482
  */
5264
5483
  sharePct: number;
5265
5484
  };
@@ -5285,7 +5504,7 @@ export type AccountExchangeRateWarningDto = {
5285
5504
 
5286
5505
  export type AccountsSummaryDto = {
5287
5506
  /**
5288
- * Total number of accounts
5507
+ * Total number of accounts (balance sheet: Assets + Liabilities, #696)
5289
5508
  */
5290
5509
  totalAccounts: number;
5291
5510
  /**
@@ -5795,7 +6014,7 @@ export type HoldingPnlWarningDto = {
5795
6014
  /**
5796
6015
  * Warning type
5797
6016
  */
5798
- export type type4 =
6017
+ export type type5 =
5799
6018
  | 'MISSING_COST_FX_RATE'
5800
6019
  | 'MISSING_MARKET_FX_RATE'
5801
6020
  | 'MISSING_SALE_PRICE'
@@ -5834,6 +6053,123 @@ export type AnonymousLoginResponseDto = {
5834
6053
  authToken: string;
5835
6054
  };
5836
6055
 
6056
+ export type ParserContributionMetaDto = {
6057
+ /**
6058
+ * Institution slug (lowercase kebab-case)
6059
+ */
6060
+ institution: string;
6061
+ region:
6062
+ | 'cn'
6063
+ | 'us'
6064
+ | 'de'
6065
+ | 'fr'
6066
+ | 'gb'
6067
+ | 'hk'
6068
+ | 'jp'
6069
+ | 'sg'
6070
+ | 'au'
6071
+ | 'ca'
6072
+ | 'other';
6073
+ accountType: 'checking' | 'savings' | 'credit' | 'debit' | 'investment';
6074
+ format: 'csv' | 'xlsx' | 'pdf' | 'ofx' | 'qif';
6075
+ institutionDisplayName?: string;
6076
+ encoding?: string;
6077
+ /**
6078
+ * CSV delimiter character: ",", ";", "\t" or "|"
6079
+ */
6080
+ delimiter?: string;
6081
+ /**
6082
+ * Header row count; the client omits the field when it is 1
6083
+ */
6084
+ headerRows?: number;
6085
+ notes?: string;
6086
+ };
6087
+
6088
+ export type region =
6089
+ | 'cn'
6090
+ | 'us'
6091
+ | 'de'
6092
+ | 'fr'
6093
+ | 'gb'
6094
+ | 'hk'
6095
+ | 'jp'
6096
+ | 'sg'
6097
+ | 'au'
6098
+ | 'ca'
6099
+ | 'other';
6100
+
6101
+ export type accountType =
6102
+ | 'checking'
6103
+ | 'savings'
6104
+ | 'credit'
6105
+ | 'debit'
6106
+ | 'investment';
6107
+
6108
+ export type format = 'csv' | 'xlsx' | 'pdf' | 'ofx' | 'qif';
6109
+
6110
+ export type ParserContributionSamplesDto = {
6111
+ /**
6112
+ * Client-sanitized sample rows (key = column name, value = cell)
6113
+ */
6114
+ rows: Array<{
6115
+ [key: string]: unknown;
6116
+ }>;
6117
+ rawHeaders?: Array<string>;
6118
+ };
6119
+
6120
+ export type FieldHintDto = {
6121
+ columnName: string;
6122
+ /**
6123
+ * Date format, e.g. yyyy-MM-dd HH:mm
6124
+ */
6125
+ format?: string;
6126
+ signConvention?: 'negative-expense' | 'positive-expense' | 'separate-columns';
6127
+ creditColumn?: string;
6128
+ debitColumn?: string;
6129
+ };
6130
+
6131
+ export type signConvention =
6132
+ | 'negative-expense'
6133
+ | 'positive-expense'
6134
+ | 'separate-columns';
6135
+
6136
+ export type ParserContributionFieldHintsDto = {
6137
+ date: FieldHintDto;
6138
+ amount: FieldHintDto;
6139
+ description?: FieldHintDto;
6140
+ balance?: FieldHintDto;
6141
+ payee?: FieldHintDto;
6142
+ reference?: FieldHintDto;
6143
+ category?: FieldHintDto;
6144
+ };
6145
+
6146
+ export type ExpectedTransactionDto = {
6147
+ date: string;
6148
+ amount: number;
6149
+ description: string;
6150
+ payee?: string;
6151
+ category?: string;
6152
+ };
6153
+
6154
+ export type ParserContributionExamplesDto = {
6155
+ expectedTransactions: Array<ExpectedTransactionDto>;
6156
+ };
6157
+
6158
+ export type ParserContributionRequestDto = {
6159
+ meta: ParserContributionMetaDto;
6160
+ samples: ParserContributionSamplesDto;
6161
+ fieldHints: ParserContributionFieldHintsDto;
6162
+ /**
6163
+ * Omitted entirely by the client when empty
6164
+ */
6165
+ examples?: ParserContributionExamplesDto;
6166
+ };
6167
+
6168
+ export type ParserContributionRelayResponseDto = {
6169
+ issueUrl: string;
6170
+ issueNumber: number;
6171
+ };
6172
+
5837
6173
  export type SymbolSearchResultDto = {
5838
6174
  symbol: string;
5839
6175
  name?: {
@@ -6319,7 +6655,7 @@ export type AccountStandardsControllerGetTemplatesData = {
6319
6655
  | 'tw'
6320
6656
  | 'us';
6321
6657
  /**
6322
- * Search term for path or description
6658
+ * Search term for path, description, aliases, or localized display name
6323
6659
  */
6324
6660
  search?: string;
6325
6661
  /**
@@ -6449,7 +6785,7 @@ export type TransactionControllerListData = {
6449
6785
  */
6450
6786
  accountId?: string;
6451
6787
  /**
6452
- * Filter by ADR-0075 functional category (Group segment); matches any posting to an Expenses/Income account whose derived Group segment equals this value
6788
+ * Filter by ADR-0075 functional category (Group segment); matches any posting to an account whose derived Group segment equals this value. Must be accompanied by flow (ADR-0126).
6453
6789
  */
6454
6790
  category?: string;
6455
6791
  /**
@@ -6460,6 +6796,10 @@ export type TransactionControllerListData = {
6460
6796
  * Filter by end date (inclusive), format: YYYY-MM-DD
6461
6797
  */
6462
6798
  dateTo?: string;
6799
+ /**
6800
+ * Required when category is present (400 otherwise) and vice versa (ADR-0126). Restricts the category account set to the flow root (income → Income:, expense → Expenses:) and drives the per-leg sign normalization of row viewpointAmount and the summary. OpenAPI cannot express conditional requiredness — the pairing is enforced at runtime.
6801
+ */
6802
+ flow?: 'income' | 'expense';
6463
6803
  /**
6464
6804
  * Number of items per page (1-100, default: 20)
6465
6805
  */
@@ -6502,9 +6842,9 @@ export type TransactionControllerListData = {
6502
6842
  */
6503
6843
  search?: string;
6504
6844
  /**
6505
- * Filter by transaction status
6845
+ * Filter by transaction status: single value, comma-separated multi-value (e.g. VOIDED,SUPERSEDED), or ALL to include audit rows. Defaults to ACTIVE-only (ADR-0128; previously unfiltered — breaking change).
6506
6846
  */
6507
- status?: 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
6847
+ status?: 'ACTIVE' | 'VOIDED' | 'SUPERSEDED' | 'ALL';
6508
6848
  };
6509
6849
 
6510
6850
  export type TransactionControllerListResponse = TransactionListResponseDto;
@@ -7261,8 +7601,7 @@ export type PayeeProfileAdminControllerUnverifyData = {
7261
7601
  id: string;
7262
7602
  };
7263
7603
 
7264
- export type PayeeProfileAdminControllerUnverifyResponse =
7265
- PayeeProfileResponseDto;
7604
+ export type PayeeProfileAdminControllerUnverifyResponse = void;
7266
7605
 
7267
7606
  export type CommodityControllerCreateData = {
7268
7607
  /**
@@ -7526,7 +7865,168 @@ export type CommodityControllerBulkCreateData = {
7526
7865
  | 'us';
7527
7866
  };
7528
7867
 
7529
- export type CommodityControllerBulkCreateResponse = Array<CommodityResponseDto>;
7868
+ export type CommodityControllerBulkCreateResponse = Array<CommodityResponseDto>;
7869
+
7870
+ export type ReportingControllerGetPortfolioTrendsData = {
7871
+ /**
7872
+ * Data granularity
7873
+ */
7874
+ granularity?: 'day' | 'week' | 'month';
7875
+ /**
7876
+ * Time period
7877
+ */
7878
+ period?: '1m' | '3m' | '6m' | '1y';
7879
+ /**
7880
+ * Region code for tenant context
7881
+ */
7882
+ region:
7883
+ | 'ad'
7884
+ | 'ae'
7885
+ | 'af'
7886
+ | 'ag'
7887
+ | 'al'
7888
+ | 'am'
7889
+ | 'ao'
7890
+ | 'au'
7891
+ | 'br'
7892
+ | 'ca'
7893
+ | 'cn'
7894
+ | 'de'
7895
+ | 'dz'
7896
+ | 'es'
7897
+ | 'fr'
7898
+ | 'gb'
7899
+ | 'hk'
7900
+ | 'in'
7901
+ | 'it'
7902
+ | 'jp'
7903
+ | 'kr'
7904
+ | 'nl'
7905
+ | 'sg'
7906
+ | 'tw'
7907
+ | 'us';
7908
+ };
7909
+
7910
+ export type ReportingControllerGetPortfolioTrendsResponse =
7911
+ PortfolioTrendsResponseDto;
7912
+
7913
+ export type ReportingControllerGetCashFlowTrendsData = {
7914
+ /**
7915
+ * Data granularity (accepted for API symmetry; v1 returns month buckets)
7916
+ */
7917
+ granularity?: 'day' | 'week' | 'month';
7918
+ /**
7919
+ * Time period
7920
+ */
7921
+ period?: '1m' | '3m' | '6m' | '1y';
7922
+ /**
7923
+ * Region code for tenant context
7924
+ */
7925
+ region:
7926
+ | 'ad'
7927
+ | 'ae'
7928
+ | 'af'
7929
+ | 'ag'
7930
+ | 'al'
7931
+ | 'am'
7932
+ | 'ao'
7933
+ | 'au'
7934
+ | 'br'
7935
+ | 'ca'
7936
+ | 'cn'
7937
+ | 'de'
7938
+ | 'dz'
7939
+ | 'es'
7940
+ | 'fr'
7941
+ | 'gb'
7942
+ | 'hk'
7943
+ | 'in'
7944
+ | 'it'
7945
+ | 'jp'
7946
+ | 'kr'
7947
+ | 'nl'
7948
+ | 'sg'
7949
+ | 'tw'
7950
+ | 'us';
7951
+ };
7952
+
7953
+ export type ReportingControllerGetCashFlowTrendsResponse =
7954
+ CashFlowTrendsResponseDto;
7955
+
7956
+ export type ReportingControllerGenerateSnapshotData = {
7957
+ /**
7958
+ * Region code for tenant context
7959
+ */
7960
+ region:
7961
+ | 'ad'
7962
+ | 'ae'
7963
+ | 'af'
7964
+ | 'ag'
7965
+ | 'al'
7966
+ | 'am'
7967
+ | 'ao'
7968
+ | 'au'
7969
+ | 'br'
7970
+ | 'ca'
7971
+ | 'cn'
7972
+ | 'de'
7973
+ | 'dz'
7974
+ | 'es'
7975
+ | 'fr'
7976
+ | 'gb'
7977
+ | 'hk'
7978
+ | 'in'
7979
+ | 'it'
7980
+ | 'jp'
7981
+ | 'kr'
7982
+ | 'nl'
7983
+ | 'sg'
7984
+ | 'tw'
7985
+ | 'us';
7986
+ /**
7987
+ * Optional date (defaults to today)
7988
+ */
7989
+ requestBody: GenerateSnapshotBody;
7990
+ };
7991
+
7992
+ export type ReportingControllerGenerateSnapshotResponse =
7993
+ GenerateSnapshotResponse;
7994
+
7995
+ export type ReportingControllerBackfillSnapshotsData = {
7996
+ /**
7997
+ * Region code for tenant context
7998
+ */
7999
+ region:
8000
+ | 'ad'
8001
+ | 'ae'
8002
+ | 'af'
8003
+ | 'ag'
8004
+ | 'al'
8005
+ | 'am'
8006
+ | 'ao'
8007
+ | 'au'
8008
+ | 'br'
8009
+ | 'ca'
8010
+ | 'cn'
8011
+ | 'de'
8012
+ | 'dz'
8013
+ | 'es'
8014
+ | 'fr'
8015
+ | 'gb'
8016
+ | 'hk'
8017
+ | 'in'
8018
+ | 'it'
8019
+ | 'jp'
8020
+ | 'kr'
8021
+ | 'nl'
8022
+ | 'sg'
8023
+ | 'tw'
8024
+ | 'us';
8025
+ requestBody: BackfillSnapshotsBody;
8026
+ };
8027
+
8028
+ export type ReportingControllerBackfillSnapshotsResponse =
8029
+ BackfillSnapshotsResponse;
7530
8030
 
7531
8031
  export type PriceControllerCreateData = {
7532
8032
  /**
@@ -7775,6 +8275,93 @@ export type PriceControllerBulkCreateData = {
7775
8275
 
7776
8276
  export type PriceControllerBulkCreateResponse = Array<PriceResponseDto>;
7777
8277
 
8278
+ export type UserControllerDeleteOwnUserData = {
8279
+ requestBody: DeleteOwnUserDto;
8280
+ };
8281
+
8282
+ export type UserControllerDeleteOwnUserResponse = void;
8283
+
8284
+ export type UserControllerGetUserData = {
8285
+ acceptLanguage: string;
8286
+ };
8287
+
8288
+ export type UserControllerGetUserResponse = UserResponseDto;
8289
+
8290
+ export type UserControllerSignupUserData = {
8291
+ requestBody: SignupDto;
8292
+ };
8293
+
8294
+ export type UserControllerSignupUserResponse = SignupResponseDto;
8295
+
8296
+ export type UserControllerDeleteUserData = {
8297
+ /**
8298
+ * User ID to delete
8299
+ */
8300
+ id: string;
8301
+ };
8302
+
8303
+ export type UserControllerDeleteUserResponse = void;
8304
+
8305
+ export type UserControllerGetUserInfoData = {
8306
+ /**
8307
+ * User ID
8308
+ */
8309
+ id: string;
8310
+ };
8311
+
8312
+ export type UserControllerGetUserInfoResponse = unknown;
8313
+
8314
+ export type UserControllerUpdateUserSettingData = {
8315
+ requestBody: UpdateUserSettingDto;
8316
+ };
8317
+
8318
+ export type UserControllerUpdateUserSettingResponse = unknown;
8319
+
8320
+ export type UserControllerGetAllUserSettingsByPageData = {
8321
+ /**
8322
+ * Page number
8323
+ */
8324
+ pageNo: number;
8325
+ /**
8326
+ * Page size
8327
+ */
8328
+ pageSize: number;
8329
+ };
8330
+
8331
+ export type UserControllerGetAllUserSettingsByPageResponse = unknown;
8332
+
8333
+ export type UserControllerGetAssetLiabilitySummaryResponse = unknown;
8334
+
8335
+ export type PropertyControllerGetAllResponse = unknown;
8336
+
8337
+ export type PropertyControllerGetByKeyData = {
8338
+ /**
8339
+ * Property key
8340
+ */
8341
+ key: string;
8342
+ };
8343
+
8344
+ export type PropertyControllerGetByKeyResponse = unknown;
8345
+
8346
+ export type PropertyControllerUpdateData = {
8347
+ /**
8348
+ * Property key
8349
+ */
8350
+ key: string;
8351
+ requestBody: UpdatePropertyDto;
8352
+ };
8353
+
8354
+ export type PropertyControllerUpdateResponse = unknown;
8355
+
8356
+ export type PropertyControllerDeleteData = {
8357
+ /**
8358
+ * Property key
8359
+ */
8360
+ key: string;
8361
+ };
8362
+
8363
+ export type PropertyControllerDeleteResponse = void;
8364
+
7778
8365
  export type RecurringRuleControllerCreateData = {
7779
8366
  /**
7780
8367
  * Region code for tenant context
@@ -8251,8 +8838,7 @@ export type ExpectedTransactionControllerUndoSkipData = {
8251
8838
  | 'us';
8252
8839
  };
8253
8840
 
8254
- export type ExpectedTransactionControllerUndoSkipResponse =
8255
- ExpectedTransactionResponseDto;
8841
+ export type ExpectedTransactionControllerUndoSkipResponse = void;
8256
8842
 
8257
8843
  export type ExpectedTransactionControllerConfirmMatchData = {
8258
8844
  /**
@@ -8329,7 +8915,7 @@ export type ExpectedTransactionControllerUnmatchData = {
8329
8915
  | 'us';
8330
8916
  };
8331
8917
 
8332
- export type ExpectedTransactionControllerUnmatchResponse = unknown;
8918
+ export type ExpectedTransactionControllerUnmatchResponse = void;
8333
8919
 
8334
8920
  export type ExpectedTransactionControllerEnterNowData = {
8335
8921
  /**
@@ -8368,172 +8954,13 @@ export type ExpectedTransactionControllerEnterNowData = {
8368
8954
  requestBody: EnterNowDto;
8369
8955
  };
8370
8956
 
8371
- export type ExpectedTransactionControllerEnterNowResponse = unknown;
8372
-
8373
- export type ForecastControllerGetForecastData = {
8374
- /**
8375
- * Number of months to forecast (1-12, default 3)
8376
- */
8377
- months?: number;
8378
- /**
8379
- * Region code for tenant context
8380
- */
8381
- region:
8382
- | 'ad'
8383
- | 'ae'
8384
- | 'af'
8385
- | 'ag'
8386
- | 'al'
8387
- | 'am'
8388
- | 'ao'
8389
- | 'au'
8390
- | 'br'
8391
- | 'ca'
8392
- | 'cn'
8393
- | 'de'
8394
- | 'dz'
8395
- | 'es'
8396
- | 'fr'
8397
- | 'gb'
8398
- | 'hk'
8399
- | 'in'
8400
- | 'it'
8401
- | 'jp'
8402
- | 'kr'
8403
- | 'nl'
8404
- | 'sg'
8405
- | 'tw'
8406
- | 'us';
8407
- };
8408
-
8409
- export type ForecastControllerGetForecastResponse = ForecastResponseDto;
8410
-
8411
- export type ReportingControllerGetPortfolioTrendsData = {
8412
- /**
8413
- * Data granularity
8414
- */
8415
- granularity?: 'day' | 'week' | 'month';
8416
- /**
8417
- * Time period
8418
- */
8419
- period?: '1m' | '3m' | '6m' | '1y';
8420
- /**
8421
- * Region code for tenant context
8422
- */
8423
- region:
8424
- | 'ad'
8425
- | 'ae'
8426
- | 'af'
8427
- | 'ag'
8428
- | 'al'
8429
- | 'am'
8430
- | 'ao'
8431
- | 'au'
8432
- | 'br'
8433
- | 'ca'
8434
- | 'cn'
8435
- | 'de'
8436
- | 'dz'
8437
- | 'es'
8438
- | 'fr'
8439
- | 'gb'
8440
- | 'hk'
8441
- | 'in'
8442
- | 'it'
8443
- | 'jp'
8444
- | 'kr'
8445
- | 'nl'
8446
- | 'sg'
8447
- | 'tw'
8448
- | 'us';
8449
- };
8450
-
8451
- export type ReportingControllerGetPortfolioTrendsResponse =
8452
- PortfolioTrendsResponseDto;
8453
-
8454
- export type ReportingControllerGetCashFlowTrendsData = {
8455
- /**
8456
- * Data granularity (accepted for API symmetry; v1 returns month buckets)
8457
- */
8458
- granularity?: 'day' | 'week' | 'month';
8459
- /**
8460
- * Time period
8461
- */
8462
- period?: '1m' | '3m' | '6m' | '1y';
8463
- /**
8464
- * Region code for tenant context
8465
- */
8466
- region:
8467
- | 'ad'
8468
- | 'ae'
8469
- | 'af'
8470
- | 'ag'
8471
- | 'al'
8472
- | 'am'
8473
- | 'ao'
8474
- | 'au'
8475
- | 'br'
8476
- | 'ca'
8477
- | 'cn'
8478
- | 'de'
8479
- | 'dz'
8480
- | 'es'
8481
- | 'fr'
8482
- | 'gb'
8483
- | 'hk'
8484
- | 'in'
8485
- | 'it'
8486
- | 'jp'
8487
- | 'kr'
8488
- | 'nl'
8489
- | 'sg'
8490
- | 'tw'
8491
- | 'us';
8492
- };
8493
-
8494
- export type ReportingControllerGetCashFlowTrendsResponse =
8495
- CashFlowTrendsResponseDto;
8496
-
8497
- export type ReportingControllerGenerateSnapshotData = {
8498
- /**
8499
- * Region code for tenant context
8500
- */
8501
- region:
8502
- | 'ad'
8503
- | 'ae'
8504
- | 'af'
8505
- | 'ag'
8506
- | 'al'
8507
- | 'am'
8508
- | 'ao'
8509
- | 'au'
8510
- | 'br'
8511
- | 'ca'
8512
- | 'cn'
8513
- | 'de'
8514
- | 'dz'
8515
- | 'es'
8516
- | 'fr'
8517
- | 'gb'
8518
- | 'hk'
8519
- | 'in'
8520
- | 'it'
8521
- | 'jp'
8522
- | 'kr'
8523
- | 'nl'
8524
- | 'sg'
8525
- | 'tw'
8526
- | 'us';
8527
- /**
8528
- * Optional date (defaults to today)
8529
- */
8530
- requestBody: GenerateSnapshotBody;
8531
- };
8532
-
8533
- export type ReportingControllerGenerateSnapshotResponse =
8534
- GenerateSnapshotResponse;
8535
-
8536
- export type ReportingControllerBackfillSnapshotsData = {
8957
+ export type ExpectedTransactionControllerEnterNowResponse = unknown;
8958
+
8959
+ export type ForecastControllerGetForecastData = {
8960
+ /**
8961
+ * Number of months to forecast (1-12, default 3)
8962
+ */
8963
+ months?: number;
8537
8964
  /**
8538
8965
  * Region code for tenant context
8539
8966
  */
@@ -8563,98 +8990,9 @@ export type ReportingControllerBackfillSnapshotsData = {
8563
8990
  | 'sg'
8564
8991
  | 'tw'
8565
8992
  | 'us';
8566
- requestBody: BackfillSnapshotsBody;
8567
- };
8568
-
8569
- export type ReportingControllerBackfillSnapshotsResponse =
8570
- BackfillSnapshotsResponse;
8571
-
8572
- export type UserControllerDeleteOwnUserData = {
8573
- requestBody: DeleteOwnUserDto;
8574
- };
8575
-
8576
- export type UserControllerDeleteOwnUserResponse = void;
8577
-
8578
- export type UserControllerGetUserData = {
8579
- acceptLanguage: string;
8580
- };
8581
-
8582
- export type UserControllerGetUserResponse = UserResponseDto;
8583
-
8584
- export type UserControllerSignupUserData = {
8585
- requestBody: SignupDto;
8586
- };
8587
-
8588
- export type UserControllerSignupUserResponse = SignupResponseDto;
8589
-
8590
- export type UserControllerDeleteUserData = {
8591
- /**
8592
- * User ID to delete
8593
- */
8594
- id: string;
8595
- };
8596
-
8597
- export type UserControllerDeleteUserResponse = void;
8598
-
8599
- export type UserControllerGetUserInfoData = {
8600
- /**
8601
- * User ID
8602
- */
8603
- id: string;
8604
- };
8605
-
8606
- export type UserControllerGetUserInfoResponse = unknown;
8607
-
8608
- export type UserControllerUpdateUserSettingData = {
8609
- requestBody: UpdateUserSettingDto;
8610
- };
8611
-
8612
- export type UserControllerUpdateUserSettingResponse = unknown;
8613
-
8614
- export type UserControllerGetAllUserSettingsByPageData = {
8615
- /**
8616
- * Page number
8617
- */
8618
- pageNo: number;
8619
- /**
8620
- * Page size
8621
- */
8622
- pageSize: number;
8623
- };
8624
-
8625
- export type UserControllerGetAllUserSettingsByPageResponse = unknown;
8626
-
8627
- export type UserControllerGetAssetLiabilitySummaryResponse = unknown;
8628
-
8629
- export type PropertyControllerGetAllResponse = unknown;
8630
-
8631
- export type PropertyControllerGetByKeyData = {
8632
- /**
8633
- * Property key
8634
- */
8635
- key: string;
8636
- };
8637
-
8638
- export type PropertyControllerGetByKeyResponse = unknown;
8639
-
8640
- export type PropertyControllerUpdateData = {
8641
- /**
8642
- * Property key
8643
- */
8644
- key: string;
8645
- requestBody: UpdatePropertyDto;
8646
- };
8647
-
8648
- export type PropertyControllerUpdateResponse = unknown;
8649
-
8650
- export type PropertyControllerDeleteData = {
8651
- /**
8652
- * Property key
8653
- */
8654
- key: string;
8655
8993
  };
8656
8994
 
8657
- export type PropertyControllerDeleteResponse = void;
8995
+ export type ForecastControllerGetForecastResponse = ForecastResponseDto;
8658
8996
 
8659
8997
  export type TransactionRuleControllerCreateData = {
8660
8998
  /**
@@ -9528,7 +9866,7 @@ export type ReconciliationControllerHistoryData = {
9528
9866
  export type ReconciliationControllerHistoryResponse =
9529
9867
  Array<ReconciliationRecordDto>;
9530
9868
 
9531
- export type ExportControllerExportBeancountResponse = unknown;
9869
+ export type ExportControllerExportBeancountResponse = Blob | File;
9532
9870
 
9533
9871
  export type FileImportControllerImportFileData = {
9534
9872
  /**
@@ -10286,6 +10624,24 @@ export type PlatformControllerMatchPlatformsData = {
10286
10624
 
10287
10625
  export type PlatformControllerMatchPlatformsResponse = PlatformMatchResponseDto;
10288
10626
 
10627
+ export type PlatformControllerGetPlatformStandardsData = {
10628
+ /**
10629
+ * Platform ID (from a match result)
10630
+ */
10631
+ id: string;
10632
+ /**
10633
+ * Region code (ISO 3166-1 alpha-2, case-insensitive). Required for global platforms (countryCode null) — resolved as their template region; ignored when the platform has its own countryCode.
10634
+ */
10635
+ region?: string;
10636
+ /**
10637
+ * Filter templates by account type (path first segment)
10638
+ */
10639
+ type?: 'Assets' | 'Liabilities' | 'Income' | 'Expenses' | 'Equity';
10640
+ };
10641
+
10642
+ export type PlatformControllerGetPlatformStandardsResponse =
10643
+ PlatformStandardsResponseDto;
10644
+
10289
10645
  export type PlatformControllerUpdateData = {
10290
10646
  /**
10291
10647
  * Platform ID
@@ -10535,6 +10891,42 @@ export type AuthControllerAccessTokenLoginData = {
10535
10891
 
10536
10892
  export type AuthControllerAccessTokenLoginResponse = AnonymousLoginResponseDto;
10537
10893
 
10894
+ export type ParserContributionControllerCreateData = {
10895
+ /**
10896
+ * Region code for tenant context (routing only; the institution region rides in the payload meta)
10897
+ */
10898
+ region:
10899
+ | 'ad'
10900
+ | 'ae'
10901
+ | 'af'
10902
+ | 'ag'
10903
+ | 'al'
10904
+ | 'am'
10905
+ | 'ao'
10906
+ | 'au'
10907
+ | 'br'
10908
+ | 'ca'
10909
+ | 'cn'
10910
+ | 'de'
10911
+ | 'dz'
10912
+ | 'es'
10913
+ | 'fr'
10914
+ | 'gb'
10915
+ | 'hk'
10916
+ | 'in'
10917
+ | 'it'
10918
+ | 'jp'
10919
+ | 'kr'
10920
+ | 'nl'
10921
+ | 'sg'
10922
+ | 'tw'
10923
+ | 'us';
10924
+ requestBody: ParserContributionRequestDto;
10925
+ };
10926
+
10927
+ export type ParserContributionControllerCreateResponse =
10928
+ ParserContributionRelayResponseDto;
10929
+
10538
10930
  export type CacheControllerFlushCacheResponse = unknown;
10539
10931
 
10540
10932
  export type ExchangeRateControllerGetExchangeRateData = {
@@ -11228,7 +11620,7 @@ export type $OpenApiTs = {
11228
11620
  /**
11229
11621
  * Payee profile unverified successfully
11230
11622
  */
11231
- 200: PayeeProfileResponseDto;
11623
+ 204: void;
11232
11624
  /**
11233
11625
  * Admin access required
11234
11626
  */
@@ -11335,598 +11727,598 @@ export type $OpenApiTs = {
11335
11727
  };
11336
11728
  };
11337
11729
  };
11338
- '/api/v1/{region}/bean/prices': {
11339
- post: {
11340
- req: PriceControllerCreateData;
11730
+ '/api/v1/{region}/reporting/portfolio/trends': {
11731
+ get: {
11732
+ req: ReportingControllerGetPortfolioTrendsData;
11341
11733
  res: {
11342
11734
  /**
11343
- * Price created successfully
11344
- */
11345
- 201: PriceResponseDto;
11346
- /**
11347
- * Currency or quoteCurrency commodity not found
11348
- */
11349
- 404: unknown;
11350
- /**
11351
- * Price already exists for this currency pair and date
11735
+ * Trends retrieved successfully
11352
11736
  */
11353
- 409: unknown;
11354
- };
11355
- };
11356
- get: {
11357
- req: PriceControllerFindAllData;
11358
- res: {
11737
+ 200: PortfolioTrendsResponseDto;
11359
11738
  /**
11360
- * Prices retrieved successfully
11739
+ * User not authenticated
11361
11740
  */
11362
- 200: PriceListResponseDto;
11741
+ 401: unknown;
11363
11742
  };
11364
11743
  };
11365
11744
  };
11366
- '/api/v1/{region}/bean/prices/{id}': {
11745
+ '/api/v1/{region}/reporting/cash-flow/trends': {
11367
11746
  get: {
11368
- req: PriceControllerFindOneData;
11369
- res: {
11370
- /**
11371
- * Price retrieved successfully
11372
- */
11373
- 200: PriceResponseDto;
11374
- /**
11375
- * Price not found
11376
- */
11377
- 404: unknown;
11378
- };
11379
- };
11380
- put: {
11381
- req: PriceControllerUpdateData;
11747
+ req: ReportingControllerGetCashFlowTrendsData;
11382
11748
  res: {
11383
11749
  /**
11384
- * Price updated successfully
11385
- */
11386
- 200: PriceResponseDto;
11387
- /**
11388
- * Price not found
11750
+ * Cash-flow trends retrieved successfully
11389
11751
  */
11390
- 404: unknown;
11752
+ 200: CashFlowTrendsResponseDto;
11391
11753
  /**
11392
- * Updated price conflicts with existing price
11754
+ * User not authenticated
11393
11755
  */
11394
- 409: unknown;
11756
+ 401: unknown;
11395
11757
  };
11396
11758
  };
11397
- delete: {
11398
- req: PriceControllerDeleteData;
11759
+ };
11760
+ '/api/v1/{region}/reporting/snapshots/generate': {
11761
+ post: {
11762
+ req: ReportingControllerGenerateSnapshotData;
11399
11763
  res: {
11400
11764
  /**
11401
- * Price deleted successfully
11765
+ * Snapshot generated successfully
11402
11766
  */
11403
- 204: void;
11767
+ 200: GenerateSnapshotResponse;
11404
11768
  /**
11405
- * Price not found
11769
+ * Invalid date format
11406
11770
  */
11407
- 404: unknown;
11408
- };
11409
- };
11410
- };
11411
- '/api/v1/{region}/bean/prices/bulk': {
11412
- post: {
11413
- req: PriceControllerBulkCreateData;
11414
- res: {
11771
+ 400: unknown;
11415
11772
  /**
11416
- * Prices created successfully
11773
+ * User not authenticated
11417
11774
  */
11418
- 201: Array<PriceResponseDto>;
11775
+ 401: unknown;
11419
11776
  };
11420
11777
  };
11421
11778
  };
11422
- '/api/v1/{region}/bean/recurring-rules': {
11779
+ '/api/v1/{region}/reporting/snapshots/backfill': {
11423
11780
  post: {
11424
- req: RecurringRuleControllerCreateData;
11781
+ req: ReportingControllerBackfillSnapshotsData;
11425
11782
  res: {
11426
11783
  /**
11427
- * Rule created successfully
11784
+ * Backfill completed successfully
11428
11785
  */
11429
- 201: RecurringRuleResponseDto;
11786
+ 200: BackfillSnapshotsResponse;
11430
11787
  /**
11431
- * Invalid input data (e.g., autoCreate without accounts)
11788
+ * Invalid date format or range
11432
11789
  */
11433
11790
  400: unknown;
11434
11791
  /**
11435
- * Rule with same name already exists
11792
+ * User not authenticated
11436
11793
  */
11437
- 409: unknown;
11438
- };
11439
- };
11440
- get: {
11441
- req: RecurringRuleControllerFindAllData;
11442
- res: {
11794
+ 401: unknown;
11443
11795
  /**
11444
- * Rules retrieved successfully
11796
+ * Backfill already in progress for this user
11445
11797
  */
11446
- 200: Array<RecurringRuleResponseDto>;
11798
+ 409: unknown;
11447
11799
  };
11448
11800
  };
11449
11801
  };
11450
- '/api/v1/{region}/bean/recurring-rules/from-transaction/{transactionId}': {
11802
+ '/api/v1/{region}/bean/prices': {
11451
11803
  post: {
11452
- req: RecurringRuleControllerCreateFromTransactionData;
11804
+ req: PriceControllerCreateData;
11453
11805
  res: {
11454
11806
  /**
11455
- * Rule created successfully
11807
+ * Price created successfully
11808
+ */
11809
+ 201: PriceResponseDto;
11810
+ /**
11811
+ * Currency or quoteCurrency commodity not found
11456
11812
  */
11457
- 201: RecurringRuleResponseDto;
11813
+ 404: unknown;
11458
11814
  /**
11459
- * Transaction not found
11815
+ * Price already exists for this currency pair and date
11460
11816
  */
11461
- 404: ApiProblemResponseDto;
11817
+ 409: unknown;
11818
+ };
11819
+ };
11820
+ get: {
11821
+ req: PriceControllerFindAllData;
11822
+ res: {
11462
11823
  /**
11463
- * Rule with same name already exists or transaction already linked
11824
+ * Prices retrieved successfully
11464
11825
  */
11465
- 409: ApiProblemResponseDto;
11826
+ 200: PriceListResponseDto;
11466
11827
  };
11467
11828
  };
11468
11829
  };
11469
- '/api/v1/{region}/bean/recurring-rules/{id}': {
11830
+ '/api/v1/{region}/bean/prices/{id}': {
11470
11831
  get: {
11471
- req: RecurringRuleControllerFindOneData;
11832
+ req: PriceControllerFindOneData;
11472
11833
  res: {
11473
11834
  /**
11474
- * Rule retrieved successfully
11835
+ * Price retrieved successfully
11475
11836
  */
11476
- 200: RecurringRuleResponseDto;
11837
+ 200: PriceResponseDto;
11477
11838
  /**
11478
- * Rule not found
11839
+ * Price not found
11479
11840
  */
11480
11841
  404: unknown;
11481
11842
  };
11482
11843
  };
11483
- patch: {
11484
- req: RecurringRuleControllerUpdateData;
11844
+ put: {
11845
+ req: PriceControllerUpdateData;
11485
11846
  res: {
11486
11847
  /**
11487
- * Rule updated successfully
11848
+ * Price updated successfully
11488
11849
  */
11489
- 200: RecurringRuleResponseDto;
11850
+ 200: PriceResponseDto;
11490
11851
  /**
11491
- * Invalid input data
11852
+ * Price not found
11492
11853
  */
11493
- 400: unknown;
11854
+ 404: unknown;
11494
11855
  /**
11495
- * Rule not found
11856
+ * Updated price conflicts with existing price
11496
11857
  */
11497
- 404: unknown;
11858
+ 409: unknown;
11498
11859
  };
11499
11860
  };
11500
11861
  delete: {
11501
- req: RecurringRuleControllerDeleteData;
11862
+ req: PriceControllerDeleteData;
11502
11863
  res: {
11503
11864
  /**
11504
- * Rule deleted successfully
11865
+ * Price deleted successfully
11505
11866
  */
11506
11867
  204: void;
11507
11868
  /**
11508
- * Rule not found
11869
+ * Price not found
11509
11870
  */
11510
11871
  404: unknown;
11511
11872
  };
11512
11873
  };
11513
11874
  };
11514
- '/api/v1/{region}/bean/recurring-rules/{id}/stats': {
11515
- get: {
11516
- req: RecurringRuleControllerGetWithStatsData;
11875
+ '/api/v1/{region}/bean/prices/bulk': {
11876
+ post: {
11877
+ req: PriceControllerBulkCreateData;
11517
11878
  res: {
11518
11879
  /**
11519
- * Rule with stats retrieved successfully
11520
- */
11521
- 200: RecurringRuleWithStatsResponseDto;
11522
- /**
11523
- * Rule not found
11880
+ * Prices created successfully
11524
11881
  */
11525
- 404: unknown;
11882
+ 201: Array<PriceResponseDto>;
11526
11883
  };
11527
11884
  };
11528
11885
  };
11529
- '/api/v1/{region}/bean/expected-transactions': {
11530
- get: {
11531
- req: ExpectedTransactionControllerFindAllData;
11886
+ '/api/v1/users': {
11887
+ delete: {
11888
+ req: UserControllerDeleteOwnUserData;
11532
11889
  res: {
11533
11890
  /**
11534
- * Expected transactions retrieved successfully
11891
+ * User deleted successfully
11535
11892
  */
11536
- 200: ExpectedTransactionListResponseDto;
11537
- };
11538
- };
11539
- };
11540
- '/api/v1/{region}/bean/expected-transactions/overdue': {
11541
- get: {
11542
- req: ExpectedTransactionControllerFindOverdueData;
11543
- res: {
11893
+ 204: void;
11544
11894
  /**
11545
- * Overdue transactions retrieved successfully
11895
+ * Invalid access token
11546
11896
  */
11547
- 200: ExpectedTransactionListResponseDto;
11897
+ 403: unknown;
11548
11898
  };
11549
11899
  };
11550
- };
11551
- '/api/v1/{region}/bean/expected-transactions/{id}': {
11552
11900
  get: {
11553
- req: ExpectedTransactionControllerFindOneData;
11901
+ req: UserControllerGetUserData;
11554
11902
  res: {
11555
11903
  /**
11556
- * Expected transaction retrieved successfully
11557
- */
11558
- 200: ExpectedTransactionResponseDto;
11559
- /**
11560
- * Expected transaction not found
11904
+ * User retrieved successfully
11561
11905
  */
11562
- 404: unknown;
11906
+ 200: UserResponseDto;
11563
11907
  };
11564
11908
  };
11565
- };
11566
- '/api/v1/{region}/bean/expected-transactions/{id}/skip': {
11567
11909
  post: {
11568
- req: ExpectedTransactionControllerSkipData;
11910
+ req: UserControllerSignupUserData;
11569
11911
  res: {
11570
11912
  /**
11571
- * Expected transaction skipped successfully
11913
+ * User created successfully
11572
11914
  */
11573
- 200: ExpectedTransactionResponseDto;
11915
+ 201: SignupResponseDto;
11574
11916
  /**
11575
- * Cannot skip - not in PENDING status
11917
+ * Invalid Turnstile token (when Turnstile is enabled)
11576
11918
  */
11577
11919
  400: unknown;
11578
11920
  /**
11579
- * Expected transaction not found
11921
+ * User signup is disabled
11580
11922
  */
11581
- 404: unknown;
11923
+ 403: unknown;
11582
11924
  };
11583
11925
  };
11926
+ };
11927
+ '/api/v1/users/{id}': {
11584
11928
  delete: {
11585
- req: ExpectedTransactionControllerUndoSkipData;
11929
+ req: UserControllerDeleteUserData;
11586
11930
  res: {
11587
11931
  /**
11588
- * Skip undone successfully
11589
- */
11590
- 200: ExpectedTransactionResponseDto;
11591
- /**
11592
- * Cannot undo - not in SKIPPED status
11932
+ * User deleted successfully
11593
11933
  */
11594
- 400: unknown;
11934
+ 204: void;
11595
11935
  /**
11596
- * Expected transaction not found
11936
+ * Cannot delete own account or insufficient permissions
11597
11937
  */
11598
- 404: unknown;
11938
+ 403: unknown;
11599
11939
  };
11600
11940
  };
11601
11941
  };
11602
- '/api/v1/{region}/bean/expected-transactions/{id}/match': {
11603
- post: {
11604
- req: ExpectedTransactionControllerConfirmMatchData;
11942
+ '/api/v1/users/{id}/info': {
11943
+ get: {
11944
+ req: UserControllerGetUserInfoData;
11605
11945
  res: {
11606
11946
  /**
11607
- * Match confirmed successfully
11947
+ * User info retrieved successfully
11608
11948
  */
11609
11949
  200: unknown;
11610
11950
  /**
11611
- * Cannot match - not in PENDING status
11612
- */
11613
- 400: unknown;
11614
- /**
11615
- * Expected or actual transaction not found
11616
- */
11617
- 404: unknown;
11618
- /**
11619
- * Actual transaction already matched to another rule
11951
+ * Cannot access other user info without admin permission
11620
11952
  */
11621
- 409: unknown;
11953
+ 403: unknown;
11622
11954
  };
11623
11955
  };
11624
- delete: {
11625
- req: ExpectedTransactionControllerUnmatchData;
11956
+ };
11957
+ '/api/v1/users/setting': {
11958
+ put: {
11959
+ req: UserControllerUpdateUserSettingData;
11626
11960
  res: {
11627
11961
  /**
11628
- * Match removed successfully
11962
+ * Settings updated successfully
11629
11963
  */
11630
11964
  200: unknown;
11631
11965
  /**
11632
- * Cannot unmatch - not in COMPLETED status
11633
- */
11634
- 400: unknown;
11635
- /**
11636
- * Expected transaction not found
11966
+ * Insufficient permissions
11637
11967
  */
11638
- 404: unknown;
11968
+ 403: unknown;
11639
11969
  };
11640
11970
  };
11641
11971
  };
11642
- '/api/v1/{region}/bean/expected-transactions/{id}/enter': {
11643
- post: {
11644
- req: ExpectedTransactionControllerEnterNowData;
11972
+ '/api/v1/users/settings-by-page': {
11973
+ get: {
11974
+ req: UserControllerGetAllUserSettingsByPageData;
11645
11975
  res: {
11646
11976
  /**
11647
- * Transaction created successfully
11648
- */
11649
- 201: unknown;
11650
- /**
11651
- * Cannot enter - not in PENDING status or missing accounts
11652
- */
11653
- 400: unknown;
11654
- /**
11655
- * Expected transaction or accounts not found
11977
+ * Settings list retrieved successfully
11656
11978
  */
11657
- 404: unknown;
11979
+ 200: unknown;
11658
11980
  };
11659
11981
  };
11660
11982
  };
11661
- '/api/v1/{region}/bean/recurring/forecast': {
11983
+ '/api/v1/users/asset-liability-summary': {
11662
11984
  get: {
11663
- req: ForecastControllerGetForecastData;
11664
11985
  res: {
11665
11986
  /**
11666
- * Forecast retrieved successfully
11987
+ * Summary retrieved successfully
11667
11988
  */
11668
- 200: ForecastResponseDto;
11989
+ 200: unknown;
11669
11990
  };
11670
11991
  };
11671
11992
  };
11672
- '/api/v1/{region}/reporting/portfolio/trends': {
11993
+ '/api/v1/admin/properties': {
11673
11994
  get: {
11674
- req: ReportingControllerGetPortfolioTrendsData;
11675
11995
  res: {
11676
11996
  /**
11677
- * Trends retrieved successfully
11997
+ * Properties retrieved successfully
11678
11998
  */
11679
- 200: PortfolioTrendsResponseDto;
11999
+ 200: unknown;
11680
12000
  /**
11681
- * User not authenticated
12001
+ * Unauthorized
11682
12002
  */
11683
12003
  401: unknown;
12004
+ /**
12005
+ * Forbidden - insufficient permissions
12006
+ */
12007
+ 403: unknown;
11684
12008
  };
11685
12009
  };
11686
12010
  };
11687
- '/api/v1/{region}/reporting/cash-flow/trends': {
12011
+ '/api/v1/admin/properties/{key}': {
11688
12012
  get: {
11689
- req: ReportingControllerGetCashFlowTrendsData;
12013
+ req: PropertyControllerGetByKeyData;
11690
12014
  res: {
11691
12015
  /**
11692
- * Cash-flow trends retrieved successfully
12016
+ * Property retrieved successfully
11693
12017
  */
11694
- 200: CashFlowTrendsResponseDto;
12018
+ 200: unknown;
11695
12019
  /**
11696
- * User not authenticated
12020
+ * Unauthorized
11697
12021
  */
11698
12022
  401: unknown;
12023
+ /**
12024
+ * Forbidden - insufficient permissions
12025
+ */
12026
+ 403: unknown;
12027
+ /**
12028
+ * Property not found
12029
+ */
12030
+ 404: unknown;
11699
12031
  };
11700
12032
  };
11701
- };
11702
- '/api/v1/{region}/reporting/snapshots/generate': {
11703
- post: {
11704
- req: ReportingControllerGenerateSnapshotData;
12033
+ put: {
12034
+ req: PropertyControllerUpdateData;
11705
12035
  res: {
11706
12036
  /**
11707
- * Snapshot generated successfully
12037
+ * Property updated successfully
11708
12038
  */
11709
- 200: GenerateSnapshotResponse;
12039
+ 200: unknown;
11710
12040
  /**
11711
- * Invalid date format
12041
+ * Unauthorized
11712
12042
  */
11713
- 400: unknown;
12043
+ 401: unknown;
11714
12044
  /**
11715
- * User not authenticated
12045
+ * Forbidden - insufficient permissions
12046
+ */
12047
+ 403: unknown;
12048
+ };
12049
+ };
12050
+ delete: {
12051
+ req: PropertyControllerDeleteData;
12052
+ res: {
12053
+ /**
12054
+ * Property deleted successfully
12055
+ */
12056
+ 204: void;
12057
+ /**
12058
+ * Unauthorized
11716
12059
  */
11717
12060
  401: unknown;
12061
+ /**
12062
+ * Forbidden - insufficient permissions
12063
+ */
12064
+ 403: unknown;
12065
+ /**
12066
+ * Property not found
12067
+ */
12068
+ 404: unknown;
11718
12069
  };
11719
12070
  };
11720
12071
  };
11721
- '/api/v1/{region}/reporting/snapshots/backfill': {
12072
+ '/api/v1/{region}/bean/recurring-rules': {
11722
12073
  post: {
11723
- req: ReportingControllerBackfillSnapshotsData;
12074
+ req: RecurringRuleControllerCreateData;
11724
12075
  res: {
11725
12076
  /**
11726
- * Backfill completed successfully
12077
+ * Rule created successfully
11727
12078
  */
11728
- 200: BackfillSnapshotsResponse;
12079
+ 201: RecurringRuleResponseDto;
11729
12080
  /**
11730
- * Invalid date format or range
12081
+ * Invalid input data (e.g., autoCreate without accounts)
11731
12082
  */
11732
12083
  400: unknown;
11733
12084
  /**
11734
- * User not authenticated
12085
+ * Rule with same name already exists
11735
12086
  */
11736
- 401: unknown;
12087
+ 409: unknown;
12088
+ };
12089
+ };
12090
+ get: {
12091
+ req: RecurringRuleControllerFindAllData;
12092
+ res: {
11737
12093
  /**
11738
- * Backfill already in progress for this user
12094
+ * Rules retrieved successfully
11739
12095
  */
11740
- 409: unknown;
12096
+ 200: Array<RecurringRuleResponseDto>;
11741
12097
  };
11742
12098
  };
11743
12099
  };
11744
- '/api/v1/users': {
11745
- delete: {
11746
- req: UserControllerDeleteOwnUserData;
12100
+ '/api/v1/{region}/bean/recurring-rules/from-transaction/{transactionId}': {
12101
+ post: {
12102
+ req: RecurringRuleControllerCreateFromTransactionData;
11747
12103
  res: {
11748
12104
  /**
11749
- * User deleted successfully
12105
+ * Rule created successfully
11750
12106
  */
11751
- 204: void;
12107
+ 201: RecurringRuleResponseDto;
11752
12108
  /**
11753
- * Invalid access token
12109
+ * Transaction not found
11754
12110
  */
11755
- 403: unknown;
12111
+ 404: ApiProblemResponseDto;
12112
+ /**
12113
+ * Rule with same name already exists or transaction already linked
12114
+ */
12115
+ 409: ApiProblemResponseDto;
11756
12116
  };
11757
12117
  };
12118
+ };
12119
+ '/api/v1/{region}/bean/recurring-rules/{id}': {
11758
12120
  get: {
11759
- req: UserControllerGetUserData;
12121
+ req: RecurringRuleControllerFindOneData;
11760
12122
  res: {
11761
12123
  /**
11762
- * User retrieved successfully
12124
+ * Rule retrieved successfully
11763
12125
  */
11764
- 200: UserResponseDto;
12126
+ 200: RecurringRuleResponseDto;
12127
+ /**
12128
+ * Rule not found
12129
+ */
12130
+ 404: unknown;
11765
12131
  };
11766
12132
  };
11767
- post: {
11768
- req: UserControllerSignupUserData;
12133
+ patch: {
12134
+ req: RecurringRuleControllerUpdateData;
11769
12135
  res: {
11770
12136
  /**
11771
- * User created successfully
12137
+ * Rule updated successfully
11772
12138
  */
11773
- 201: SignupResponseDto;
12139
+ 200: RecurringRuleResponseDto;
11774
12140
  /**
11775
- * Invalid Turnstile token (when Turnstile is enabled)
12141
+ * Invalid input data
11776
12142
  */
11777
12143
  400: unknown;
11778
12144
  /**
11779
- * User signup is disabled
12145
+ * Rule not found
11780
12146
  */
11781
- 403: unknown;
12147
+ 404: unknown;
11782
12148
  };
11783
12149
  };
11784
- };
11785
- '/api/v1/users/{id}': {
11786
12150
  delete: {
11787
- req: UserControllerDeleteUserData;
12151
+ req: RecurringRuleControllerDeleteData;
11788
12152
  res: {
11789
12153
  /**
11790
- * User deleted successfully
12154
+ * Rule deleted successfully
11791
12155
  */
11792
12156
  204: void;
11793
12157
  /**
11794
- * Cannot delete own account or insufficient permissions
12158
+ * Rule not found
11795
12159
  */
11796
- 403: unknown;
12160
+ 404: unknown;
11797
12161
  };
11798
12162
  };
11799
12163
  };
11800
- '/api/v1/users/{id}/info': {
12164
+ '/api/v1/{region}/bean/recurring-rules/{id}/stats': {
11801
12165
  get: {
11802
- req: UserControllerGetUserInfoData;
12166
+ req: RecurringRuleControllerGetWithStatsData;
11803
12167
  res: {
11804
12168
  /**
11805
- * User info retrieved successfully
12169
+ * Rule with stats retrieved successfully
11806
12170
  */
11807
- 200: unknown;
12171
+ 200: RecurringRuleWithStatsResponseDto;
11808
12172
  /**
11809
- * Cannot access other user info without admin permission
12173
+ * Rule not found
11810
12174
  */
11811
- 403: unknown;
12175
+ 404: unknown;
11812
12176
  };
11813
12177
  };
11814
12178
  };
11815
- '/api/v1/users/setting': {
11816
- put: {
11817
- req: UserControllerUpdateUserSettingData;
12179
+ '/api/v1/{region}/bean/expected-transactions': {
12180
+ get: {
12181
+ req: ExpectedTransactionControllerFindAllData;
11818
12182
  res: {
11819
12183
  /**
11820
- * Settings updated successfully
11821
- */
11822
- 200: unknown;
11823
- /**
11824
- * Insufficient permissions
12184
+ * Expected transactions retrieved successfully
11825
12185
  */
11826
- 403: unknown;
12186
+ 200: ExpectedTransactionListResponseDto;
11827
12187
  };
11828
12188
  };
11829
12189
  };
11830
- '/api/v1/users/settings-by-page': {
12190
+ '/api/v1/{region}/bean/expected-transactions/overdue': {
11831
12191
  get: {
11832
- req: UserControllerGetAllUserSettingsByPageData;
12192
+ req: ExpectedTransactionControllerFindOverdueData;
11833
12193
  res: {
11834
12194
  /**
11835
- * Settings list retrieved successfully
12195
+ * Overdue transactions retrieved successfully
11836
12196
  */
11837
- 200: unknown;
12197
+ 200: ExpectedTransactionListResponseDto;
11838
12198
  };
11839
12199
  };
11840
12200
  };
11841
- '/api/v1/users/asset-liability-summary': {
12201
+ '/api/v1/{region}/bean/expected-transactions/{id}': {
11842
12202
  get: {
12203
+ req: ExpectedTransactionControllerFindOneData;
11843
12204
  res: {
11844
12205
  /**
11845
- * Summary retrieved successfully
12206
+ * Expected transaction retrieved successfully
11846
12207
  */
11847
- 200: unknown;
12208
+ 200: ExpectedTransactionResponseDto;
12209
+ /**
12210
+ * Expected transaction not found
12211
+ */
12212
+ 404: unknown;
11848
12213
  };
11849
12214
  };
11850
12215
  };
11851
- '/api/v1/admin/properties': {
11852
- get: {
12216
+ '/api/v1/{region}/bean/expected-transactions/{id}/skip': {
12217
+ post: {
12218
+ req: ExpectedTransactionControllerSkipData;
11853
12219
  res: {
11854
12220
  /**
11855
- * Properties retrieved successfully
12221
+ * Expected transaction skipped successfully
11856
12222
  */
11857
- 200: unknown;
12223
+ 200: ExpectedTransactionResponseDto;
11858
12224
  /**
11859
- * Unauthorized
12225
+ * Cannot skip - not in PENDING status
11860
12226
  */
11861
- 401: unknown;
12227
+ 400: unknown;
11862
12228
  /**
11863
- * Forbidden - insufficient permissions
12229
+ * Expected transaction not found
11864
12230
  */
11865
- 403: unknown;
12231
+ 404: unknown;
11866
12232
  };
11867
12233
  };
11868
- };
11869
- '/api/v1/admin/properties/{key}': {
11870
- get: {
11871
- req: PropertyControllerGetByKeyData;
12234
+ delete: {
12235
+ req: ExpectedTransactionControllerUndoSkipData;
11872
12236
  res: {
11873
12237
  /**
11874
- * Property retrieved successfully
11875
- */
11876
- 200: unknown;
11877
- /**
11878
- * Unauthorized
12238
+ * Skip undone successfully
11879
12239
  */
11880
- 401: unknown;
12240
+ 204: void;
11881
12241
  /**
11882
- * Forbidden - insufficient permissions
12242
+ * Cannot undo - not in SKIPPED status
11883
12243
  */
11884
- 403: unknown;
12244
+ 400: unknown;
11885
12245
  /**
11886
- * Property not found
12246
+ * Expected transaction not found
11887
12247
  */
11888
12248
  404: unknown;
11889
12249
  };
11890
12250
  };
11891
- put: {
11892
- req: PropertyControllerUpdateData;
12251
+ };
12252
+ '/api/v1/{region}/bean/expected-transactions/{id}/match': {
12253
+ post: {
12254
+ req: ExpectedTransactionControllerConfirmMatchData;
11893
12255
  res: {
11894
12256
  /**
11895
- * Property updated successfully
12257
+ * Match confirmed successfully
11896
12258
  */
11897
12259
  200: unknown;
11898
12260
  /**
11899
- * Unauthorized
12261
+ * Cannot match - not in PENDING status
11900
12262
  */
11901
- 401: unknown;
12263
+ 400: unknown;
11902
12264
  /**
11903
- * Forbidden - insufficient permissions
12265
+ * Expected or actual transaction not found
11904
12266
  */
11905
- 403: unknown;
12267
+ 404: unknown;
12268
+ /**
12269
+ * Actual transaction already matched to another rule
12270
+ */
12271
+ 409: unknown;
11906
12272
  };
11907
12273
  };
11908
12274
  delete: {
11909
- req: PropertyControllerDeleteData;
12275
+ req: ExpectedTransactionControllerUnmatchData;
11910
12276
  res: {
11911
12277
  /**
11912
- * Property deleted successfully
12278
+ * Match removed successfully
11913
12279
  */
11914
12280
  204: void;
11915
12281
  /**
11916
- * Unauthorized
12282
+ * Cannot unmatch - not in COMPLETED status
11917
12283
  */
11918
- 401: unknown;
12284
+ 400: unknown;
11919
12285
  /**
11920
- * Forbidden - insufficient permissions
12286
+ * Expected transaction not found
11921
12287
  */
11922
- 403: unknown;
12288
+ 404: unknown;
12289
+ };
12290
+ };
12291
+ };
12292
+ '/api/v1/{region}/bean/expected-transactions/{id}/enter': {
12293
+ post: {
12294
+ req: ExpectedTransactionControllerEnterNowData;
12295
+ res: {
11923
12296
  /**
11924
- * Property not found
12297
+ * Transaction created successfully
12298
+ */
12299
+ 201: unknown;
12300
+ /**
12301
+ * Cannot enter - not in PENDING status or missing accounts
12302
+ */
12303
+ 400: unknown;
12304
+ /**
12305
+ * Expected transaction or accounts not found
11925
12306
  */
11926
12307
  404: unknown;
11927
12308
  };
11928
12309
  };
11929
12310
  };
12311
+ '/api/v1/{region}/bean/recurring/forecast': {
12312
+ get: {
12313
+ req: ForecastControllerGetForecastData;
12314
+ res: {
12315
+ /**
12316
+ * Forecast retrieved successfully
12317
+ */
12318
+ 200: ForecastResponseDto;
12319
+ };
12320
+ };
12321
+ };
11930
12322
  '/api/v1/{region}/bean/transaction-rules': {
11931
12323
  post: {
11932
12324
  req: TransactionRuleControllerCreateData;
@@ -12324,7 +12716,10 @@ export type $OpenApiTs = {
12324
12716
  '/api/v1/{region}/bean/export/beancount': {
12325
12717
  get: {
12326
12718
  res: {
12327
- 200: unknown;
12719
+ /**
12720
+ * ZIP archive (application/zip) streamed as an attachment
12721
+ */
12722
+ 200: Blob | File;
12328
12723
  };
12329
12724
  };
12330
12725
  };
@@ -12705,6 +13100,17 @@ export type $OpenApiTs = {
12705
13100
  };
12706
13101
  };
12707
13102
  };
13103
+ '/api/v1/bean/platforms/{id}/standards': {
13104
+ get: {
13105
+ req: PlatformControllerGetPlatformStandardsData;
13106
+ res: {
13107
+ /**
13108
+ * Resolved region plus the merged account-standard catalog of that region (groupable by productCategory client-side)
13109
+ */
13110
+ 200: PlatformStandardsResponseDto;
13111
+ };
13112
+ };
13113
+ };
12708
13114
  '/api/v1/bean/platforms/{id}': {
12709
13115
  put: {
12710
13116
  req: PlatformControllerUpdateData;
@@ -12852,10 +13258,48 @@ export type $OpenApiTs = {
12852
13258
  };
12853
13259
  };
12854
13260
  };
13261
+ '/api/v1/{region}/community/parser-contributions': {
13262
+ post: {
13263
+ req: ParserContributionControllerCreateData;
13264
+ res: {
13265
+ /**
13266
+ * Issue created by the bot
13267
+ */
13268
+ 201: ParserContributionRelayResponseDto;
13269
+ /**
13270
+ * Unauthorized
13271
+ */
13272
+ 401: ApiProblemResponseDto;
13273
+ /**
13274
+ * Validation failed (institution slug, empty samples, row/cell size limits)
13275
+ */
13276
+ 422: ApiProblemResponseDto;
13277
+ /**
13278
+ * Rate limited (5 submissions per user per hour)
13279
+ */
13280
+ 429: ApiProblemResponseDto;
13281
+ /**
13282
+ * Relay not configured on this deployment — clients fall back to the clipboard flow
13283
+ */
13284
+ 501: ApiProblemResponseDto;
13285
+ /**
13286
+ * GitHub bot failure (upstream), safe to retry
13287
+ */
13288
+ 502: ApiProblemResponseDto;
13289
+ };
13290
+ };
13291
+ };
12855
13292
  '/api/v1/cache/flush': {
12856
13293
  post: {
12857
13294
  res: {
12858
- 201: unknown;
13295
+ /**
13296
+ * Cache flushed successfully
13297
+ */
13298
+ 200: unknown;
13299
+ /**
13300
+ * Admin access required
13301
+ */
13302
+ 403: ApiProblemResponseDto;
12859
13303
  };
12860
13304
  };
12861
13305
  };