@firela/api-types 0.0.0-canary.3ed455fd → 0.0.0-canary.43fa8a2d

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.
@@ -6,18 +6,12 @@ export const $CreateAccountDto = {
6
6
  path: {
7
7
  type: 'string',
8
8
  description: 'Account path (hierarchical, colon-separated)',
9
- example: 'Assets:CN:Bank:ICBC:Checking'
10
- },
11
- displayName: {
12
- type: 'string',
13
- description:
14
- 'Display name to distinguish accounts at the same path (default: "")',
15
- example: '工资卡'
9
+ example: 'Assets:CN:ICBC:Checking'
16
10
  },
17
11
  openDate: {
18
12
  format: 'date-time',
19
13
  type: 'string',
20
- description: 'Account open date',
14
+ description: 'Account open date (server defaults to today)',
21
15
  example: '2024-01-01'
22
16
  },
23
17
  currencies: {
@@ -45,26 +39,22 @@ export const $CreateAccountDto = {
45
39
  templatePath: {
46
40
  type: 'string',
47
41
  description: 'Reference to account-standards template path',
48
- example: 'Assets:CN:Bank:ICBC:Checking'
42
+ example: 'Assets:CN:Checking'
49
43
  },
50
44
  isCustom: {
51
45
  type: 'boolean',
52
46
  description: 'Whether this is a custom (user-created) account',
53
47
  default: false
54
48
  },
55
- i18nKey: {
56
- type: 'string',
57
- description: 'i18n key for display name (overrides template)',
58
- example: 'account.custom.mybank'
59
- },
60
49
  icon: {
61
50
  type: 'string',
62
51
  description: 'Icon identifier (overrides template)',
63
52
  example: 'bank-custom'
64
53
  },
65
- openMeta: {
54
+ openDirectiveMeta: {
66
55
  type: 'object',
67
- description: 'Additional metadata',
56
+ description:
57
+ 'Open directive metadata (NOT an opening-balance amount — use the opening-balance endpoint)',
68
58
  example: {
69
59
  branch: 'Downtown',
70
60
  accountNumber: '1234'
@@ -76,7 +66,7 @@ export const $CreateAccountDto = {
76
66
  example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
77
67
  }
78
68
  },
79
- required: ['path', 'openDate']
69
+ required: ['path']
80
70
  } as const;
81
71
 
82
72
  export const $AccountResponseDto = {
@@ -90,13 +80,7 @@ export const $AccountResponseDto = {
90
80
  path: {
91
81
  type: 'string',
92
82
  description: 'Account path (hierarchical, colon-separated)',
93
- example: 'Assets:CN:Bank:ICBC:Checking'
94
- },
95
- displayName: {
96
- type: 'string',
97
- description:
98
- 'Display name distinguishing multiple accounts at the same path',
99
- example: '工资卡'
83
+ example: 'Assets:CN:ICBC:Checking'
100
84
  },
101
85
  type: {
102
86
  type: 'string',
@@ -104,6 +88,49 @@ export const $AccountResponseDto = {
104
88
  enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
105
89
  example: 'Assets'
106
90
  },
91
+ assetSubClass: {
92
+ type: 'string',
93
+ description:
94
+ 'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
95
+ enum: [
96
+ 'DEPOSIT',
97
+ 'CASH',
98
+ 'MONEY_MARKET_FUND',
99
+ 'STOCK',
100
+ 'ETF',
101
+ 'MUTUAL_FUND',
102
+ 'EQUITY_COMPENSATION',
103
+ 'GOVERNMENT_BOND',
104
+ 'CORPORATE_BOND',
105
+ 'BOND_FUND',
106
+ 'PRIMARY_RESIDENCE',
107
+ 'INVESTMENT_PROPERTY',
108
+ 'REIT',
109
+ 'GOLD',
110
+ 'SILVER',
111
+ 'PRECIOUS_METAL',
112
+ 'PRECIOUS_METAL_FUND',
113
+ 'COMMODITY',
114
+ 'COMMODITY_FUND',
115
+ 'CRYPTOCURRENCY',
116
+ 'RETIREMENT_ACCOUNT',
117
+ 'HEALTH_ACCOUNT',
118
+ 'EDUCATION_ACCOUNT',
119
+ 'INSURANCE',
120
+ 'PRIVATE_EQUITY',
121
+ 'HEDGE_FUND',
122
+ 'COLLECTIBLES',
123
+ 'MORTGAGE',
124
+ 'STUDENT_LOAN',
125
+ 'CREDIT_CARD',
126
+ 'PERSONAL_LOAN',
127
+ 'ACCOUNTS_PAYABLE',
128
+ 'TAX_PAYABLE',
129
+ 'OTHER'
130
+ ],
131
+ nullable: true,
132
+ example: 'STOCK'
133
+ },
107
134
  status: {
108
135
  type: 'string',
109
136
  description: 'Account status',
@@ -145,26 +172,26 @@ export const $AccountResponseDto = {
145
172
  templatePath: {
146
173
  type: 'string',
147
174
  description: 'Template path reference',
148
- example: 'Assets:CN:Bank:ICBC:Checking'
175
+ example: 'Assets:CN:Checking'
149
176
  },
150
177
  isCustom: {
151
178
  type: 'boolean',
152
179
  description: 'Whether this is a custom (user-created) account',
153
180
  example: false
154
181
  },
155
- i18nKey: {
182
+ displayName: {
156
183
  type: 'string',
157
- description: 'i18n key for display name',
158
- example: 'account.assets.cn.bank.icbc.checking'
184
+ description: 'Localized display name (ADR-0114, read-time projection)',
185
+ example: 'Checking'
159
186
  },
160
187
  icon: {
161
188
  type: 'string',
162
189
  description: 'Icon identifier',
163
190
  example: 'bank-icbc'
164
191
  },
165
- openMeta: {
192
+ openDirectiveMeta: {
166
193
  type: 'object',
167
- description: 'Account metadata',
194
+ description: 'Open directive metadata (ADR-0115 Decision 9)',
168
195
  example: {
169
196
  branch: 'Downtown'
170
197
  }
@@ -192,7 +219,6 @@ export const $AccountResponseDto = {
192
219
  required: [
193
220
  'id',
194
221
  'path',
195
- 'displayName',
196
222
  'type',
197
223
  'status',
198
224
  'openDate',
@@ -225,11 +251,6 @@ export const $AccountListResponseDto = {
225
251
  export const $UpdateAccountDto = {
226
252
  type: 'object',
227
253
  properties: {
228
- displayName: {
229
- type: 'string',
230
- description: 'Display name to distinguish accounts at the same path',
231
- example: '招行工资卡'
232
- },
233
254
  currencies: {
234
255
  description: 'Allowed currencies (null = no restriction)',
235
256
  example: ['CNY', 'USD'],
@@ -251,19 +272,15 @@ export const $UpdateAccountDto = {
251
272
  'NONE'
252
273
  ]
253
274
  },
254
- i18nKey: {
255
- type: 'string',
256
- description: 'i18n key for display name',
257
- example: 'account.custom.mybank'
258
- },
259
275
  icon: {
260
276
  type: 'string',
261
277
  description: 'Icon identifier',
262
278
  example: 'bank-custom'
263
279
  },
264
- openMeta: {
280
+ openDirectiveMeta: {
265
281
  type: 'object',
266
- description: 'Additional metadata (merged with existing)',
282
+ description:
283
+ 'Open directive metadata (merged with existing; NOT an opening-balance amount)',
267
284
  example: {
268
285
  branch: 'Uptown'
269
286
  }
@@ -310,13 +327,47 @@ export const $ReopenAccountDto = {
310
327
  }
311
328
  } as const;
312
329
 
330
+ export const $CreateOpeningBalanceDto = {
331
+ type: 'object',
332
+ properties: {
333
+ amount: {
334
+ type: 'number',
335
+ description: 'Opening balance amount (non-negative)',
336
+ example: 1000
337
+ },
338
+ currency: {
339
+ type: 'string',
340
+ description: 'Currency code',
341
+ example: 'CNY'
342
+ },
343
+ date: {
344
+ format: 'date-time',
345
+ type: 'string',
346
+ description: 'Opening-balance date (defaults to now)',
347
+ example: '2024-01-01'
348
+ }
349
+ },
350
+ required: ['amount', 'currency']
351
+ } as const;
352
+
353
+ export const $OpeningBalanceResultDto = {
354
+ type: 'object',
355
+ properties: {
356
+ transactionId: {
357
+ type: 'string',
358
+ description: 'Created opening-balance transaction id.'
359
+ }
360
+ },
361
+ required: ['transactionId']
362
+ } as const;
363
+
313
364
  export const $AccountStandardResponseDto = {
314
365
  type: 'object',
315
366
  properties: {
316
367
  path: {
317
368
  type: 'string',
318
369
  description: 'Account path (hierarchical, colon-separated)',
319
- example: 'Assets:CN:Bank:ICBC:Checking'
370
+ example: 'Assets:CN:Checking'
320
371
  },
321
372
  type: {
322
373
  type: 'string',
@@ -324,11 +375,6 @@ export const $AccountStandardResponseDto = {
324
375
  enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
325
376
  example: 'Assets'
326
377
  },
327
- i18nKey: {
328
- type: 'string',
329
- description: 'i18n key for localized display name',
330
- example: 'account.assets.cn.bank.icbc.checking'
331
- },
332
378
  name: {
333
379
  type: 'string',
334
380
  description: 'Short localized display name',
@@ -351,9 +397,47 @@ export const $AccountStandardResponseDto = {
351
397
  type: 'string',
352
398
  description: 'Icon identifier for UI display',
353
399
  example: 'bank-icbc'
400
+ },
401
+ productCategory: {
402
+ type: 'string',
403
+ description:
404
+ 'Onboarding product category (coarse grouping derived from assetSubClass)',
405
+ enum: [
406
+ 'cash',
407
+ 'investment',
408
+ 'credit_card',
409
+ 'loan',
410
+ 'payable_tax',
411
+ 'other'
412
+ ],
413
+ example: 'investment'
414
+ },
415
+ assetClass: {
416
+ type: 'string',
417
+ description:
418
+ 'Asset class (LIQUIDITY/EQUITY/.../LIABILITY), derived at read time from classification rules',
419
+ enum: [
420
+ 'LIQUIDITY',
421
+ 'EQUITY',
422
+ 'FIXED_INCOME',
423
+ 'PRECIOUS_METALS',
424
+ 'COMMODITY',
425
+ 'INSURANCE',
426
+ 'ALTERNATIVE_INVESTMENT',
427
+ 'PERSONAL_ASSETS',
428
+ 'LIABILITY',
429
+ 'REAL_ESTATE',
430
+ 'INDEX'
431
+ ]
432
+ },
433
+ assetSubClass: {
434
+ type: 'string',
435
+ description:
436
+ 'Asset sub-class (product type, derived at read time from classification rules)',
437
+ example: 'STOCK'
354
438
  }
355
439
  },
356
- required: ['path', 'type', 'i18nKey', 'description', 'tags', 'icon']
440
+ required: ['path', 'type', 'description', 'tags', 'icon', 'productCategory']
357
441
  } as const;
358
442
 
359
443
  export const $AccountStandardListResponseDto = {
@@ -383,18 +467,13 @@ export const $AccountStandardListResponseDto = {
383
467
  export const $TemplateMetadataDto = {
384
468
  type: 'object',
385
469
  properties: {
386
- extendable: {
387
- type: 'boolean',
388
- description: 'Whether this path can be extended',
389
- example: true
390
- },
391
470
  rootType: {
392
471
  type: 'string',
393
472
  description: 'Root account type',
394
473
  example: 'Assets'
395
474
  }
396
475
  },
397
- required: ['extendable', 'rootType']
476
+ required: ['rootType']
398
477
  } as const;
399
478
 
400
479
  export const $TemplateMetadataResponseDto = {
@@ -533,7 +612,7 @@ export const $CreatePostingDto = {
533
612
  type: 'string',
534
613
  description:
535
614
  'Account name in Beancount format (must start with uppercase, colon-separated)',
536
- example: 'Assets:Bank:Checking'
615
+ example: 'Assets:Checking'
537
616
  },
538
617
  units: {
539
618
  type: 'string',
@@ -692,7 +771,7 @@ export const $PostingResponseDto = {
692
771
  account: {
693
772
  type: 'string',
694
773
  description: 'Account name',
695
- example: 'Assets:Bank:Checking'
774
+ example: 'Assets:Checking'
696
775
  },
697
776
  units: {
698
777
  type: 'string',
@@ -1058,7 +1137,7 @@ export const $PostingDetailDto = {
1058
1137
  account: {
1059
1138
  type: 'string',
1060
1139
  description: 'Fully-qualified Beancount account path',
1061
- example: 'Assets:Bank:Checking'
1140
+ example: 'Assets:Checking'
1062
1141
  },
1063
1142
  units: {
1064
1143
  type: 'string',
@@ -1247,6 +1326,77 @@ export const $TransactionDetailDto = {
1247
1326
  ]
1248
1327
  } as const;
1249
1328
 
1329
+ export const $BalanceByCurrencyDto = {
1330
+ type: 'object',
1331
+ properties: {
1332
+ currency: {
1333
+ type: 'string',
1334
+ description: 'ISO 4217 currency code',
1335
+ example: 'CNY'
1336
+ },
1337
+ balance: {
1338
+ type: 'string',
1339
+ description: 'Balance amount',
1340
+ example: '50000.00'
1341
+ }
1342
+ },
1343
+ required: ['currency', 'balance']
1344
+ } as const;
1345
+
1346
+ export const $ExchangeRateWarningDto = {
1347
+ type: 'object',
1348
+ properties: {
1349
+ type: {
1350
+ type: 'string',
1351
+ description: 'Warning type',
1352
+ example: 'MISSING_EXCHANGE_RATE'
1353
+ },
1354
+ currency: {
1355
+ type: 'string',
1356
+ description: 'Currency without exchange rate',
1357
+ example: 'EUR'
1358
+ },
1359
+ totalAmount: {
1360
+ type: 'string',
1361
+ description: 'Total amount affected',
1362
+ example: '1000.00'
1363
+ }
1364
+ },
1365
+ required: ['type', 'currency', 'totalAmount']
1366
+ } as const;
1367
+
1368
+ export const $TransactionListSummaryDto = {
1369
+ type: 'object',
1370
+ properties: {
1371
+ totalAmount: {
1372
+ type: 'string',
1373
+ description:
1374
+ '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.',
1375
+ example: '-6000.00'
1376
+ },
1377
+ currency: {
1378
+ type: 'string',
1379
+ description: 'Base currency (ISO 4217)',
1380
+ example: 'CNY'
1381
+ },
1382
+ balanceByCurrency: {
1383
+ description: 'Raw (unconverted) balance per currency',
1384
+ type: 'array',
1385
+ items: {
1386
+ $ref: '#/components/schemas/BalanceByCurrencyDto'
1387
+ }
1388
+ },
1389
+ warnings: {
1390
+ description: 'Currencies missing an FX rate (omitted when empty)',
1391
+ type: 'array',
1392
+ items: {
1393
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
1394
+ }
1395
+ }
1396
+ },
1397
+ required: ['totalAmount', 'currency', 'balanceByCurrency']
1398
+ } as const;
1399
+
1250
1400
  export const $TransactionListResponseDto = {
1251
1401
  type: 'object',
1252
1402
  properties: {
@@ -1271,6 +1421,15 @@ export const $TransactionListResponseDto = {
1271
1421
  type: 'number',
1272
1422
  description: 'Number of items skipped',
1273
1423
  example: 0
1424
+ },
1425
+ summary: {
1426
+ description:
1427
+ '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.',
1428
+ allOf: [
1429
+ {
1430
+ $ref: '#/components/schemas/TransactionListSummaryDto'
1431
+ }
1432
+ ]
1274
1433
  }
1275
1434
  },
1276
1435
  required: ['data', 'total', 'limit', 'offset']
@@ -1370,7 +1529,7 @@ export const $BalanceResponseDto = {
1370
1529
  account: {
1371
1530
  type: 'string',
1372
1531
  description: 'Account name',
1373
- example: 'Assets:Bank:Checking'
1532
+ example: 'Assets:Checking'
1374
1533
  },
1375
1534
  balance: {
1376
1535
  type: 'string',
@@ -1397,7 +1556,7 @@ export const $MultiCurrencyBalanceResponseDto = {
1397
1556
  account: {
1398
1557
  type: 'string',
1399
1558
  description: 'Account name',
1400
- example: 'Assets:Bank:Checking'
1559
+ example: 'Assets:Checking'
1401
1560
  },
1402
1561
  balances: {
1403
1562
  type: 'object',
@@ -1453,7 +1612,7 @@ export const $TransactionSummaryDto = {
1453
1612
  accountName: {
1454
1613
  type: 'string',
1455
1614
  description: 'Source account name (first posting)',
1456
- example: 'Assets:Bank:Checking'
1615
+ example: 'Assets:Checking'
1457
1616
  },
1458
1617
  sourceType: {
1459
1618
  type: 'string',
@@ -1855,7 +2014,8 @@ export const $ResolveResultDto = {
1855
2014
  },
1856
2015
  resolutionId: {
1857
2016
  type: 'string',
1858
- description: 'Resolution ID for undo'
2017
+ description:
2018
+ 'Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).'
1859
2019
  },
1860
2020
  canUndo: {
1861
2021
  type: 'boolean',
@@ -1873,7 +2033,7 @@ export const $ResolveResultDto = {
1873
2033
  example: 'rule_01HXK5V8N2M3P4Q5R6S7T8U9V0'
1874
2034
  }
1875
2035
  },
1876
- required: ['success', 'resolutionId', 'canUndo', 'undoDeadline']
2036
+ required: ['success']
1877
2037
  } as const;
1878
2038
 
1879
2039
  export const $UndoResultDto = {
@@ -2744,64 +2904,221 @@ export const $UpdateCommodityDto = {
2744
2904
  }
2745
2905
  } as const;
2746
2906
 
2747
- export const $CreateRecurringRuleDto = {
2907
+ export const $CreateBeanPriceDto = {
2748
2908
  type: 'object',
2749
2909
  properties: {
2750
- name: {
2751
- type: 'string',
2752
- description: 'Rule name (unique per user)',
2753
- maxLength: 100
2754
- },
2755
- icon: {
2910
+ currency: {
2756
2911
  type: 'string',
2757
- description: 'Icon emoji',
2758
- maxLength: 10
2912
+ description: 'Currency being priced (e.g., USD, AAPL, BTC)',
2913
+ example: 'USD'
2759
2914
  },
2760
- frequency: {
2915
+ quoteCurrency: {
2761
2916
  type: 'string',
2762
- description: 'Recurring frequency',
2763
- enum: [
2764
- 'WEEKLY',
2765
- 'BIWEEKLY',
2766
- 'MONTHLY',
2767
- 'BIMONTHLY',
2768
- 'QUARTERLY',
2769
- 'YEARLY',
2770
- 'CUSTOM'
2771
- ]
2917
+ description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
2918
+ example: 'CNY'
2772
2919
  },
2773
- expectedAmount: {
2920
+ amount: {
2774
2921
  type: 'number',
2775
- description: 'Expected amount (positive number)',
2922
+ description:
2923
+ 'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
2924
+ example: 175.5,
2776
2925
  minimum: 0
2777
2926
  },
2778
- expectedDay: {
2779
- type: 'number',
2780
- description: 'Expected day of month (1-31)',
2781
- minimum: 1,
2782
- maximum: 31
2927
+ date: {
2928
+ type: 'string',
2929
+ description: 'Price date (ISO 8601 format)',
2930
+ example: '2024-11-05'
2783
2931
  },
2784
- customIntervalDays: {
2785
- type: 'number',
2786
- description: 'Custom interval in days (required for CUSTOM frequency)',
2787
- minimum: 1
2932
+ metadata: {
2933
+ type: 'object',
2934
+ description:
2935
+ 'Metadata (validated by Zod schema, max field lengths enforced)',
2936
+ example: {
2937
+ source: 'MANUAL',
2938
+ note: 'Bank valuation report',
2939
+ confidence: 0.95
2940
+ }
2941
+ }
2942
+ },
2943
+ required: ['currency', 'quoteCurrency', 'amount', 'date']
2944
+ } as const;
2945
+
2946
+ export const $PriceResponseDto = {
2947
+ type: 'object',
2948
+ properties: {
2949
+ id: {
2950
+ type: 'string',
2951
+ description: 'Unique identifier',
2952
+ example: 'uuid-123-456'
2953
+ },
2954
+ userId: {
2955
+ type: 'string',
2956
+ description: 'User ID (owner of the price)',
2957
+ example: 'user-123'
2788
2958
  },
2789
2959
  currency: {
2790
2960
  type: 'string',
2791
- description: 'Currency code',
2792
- default: 'CNY',
2793
- maxLength: 10
2961
+ description: 'Currency being priced (e.g., USD, AAPL, BTC)',
2962
+ example: 'BTC'
2794
2963
  },
2795
- matchPayeePattern: {
2964
+ quoteCurrency: {
2796
2965
  type: 'string',
2797
- description: 'Payee matching pattern (supports wildcards)',
2798
- maxLength: 200
2966
+ description: 'Quote currency (pricing currency, e.g., USD, CNY)',
2967
+ example: 'USD'
2799
2968
  },
2800
- matchAmountTolerance: {
2969
+ amount: {
2801
2970
  type: 'number',
2802
- description: 'Amount tolerance percentage (0-1)',
2803
- default: 0.075,
2804
- minimum: 0,
2971
+ description:
2972
+ 'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
2973
+ example: 50000
2974
+ },
2975
+ date: {
2976
+ type: 'string',
2977
+ description:
2978
+ 'Price date (ISO 8601 format). Represents the date this price was valid.',
2979
+ example: '2024-01-01',
2980
+ format: 'date'
2981
+ },
2982
+ meta: {
2983
+ type: 'object',
2984
+ description:
2985
+ 'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
2986
+ example: {
2987
+ source: 'MANUAL',
2988
+ note: 'User-defined price',
2989
+ confidence: 1
2990
+ }
2991
+ },
2992
+ createdAt: {
2993
+ format: 'date-time',
2994
+ type: 'string',
2995
+ description: 'Creation timestamp',
2996
+ example: '2024-11-03T10:00:00Z'
2997
+ },
2998
+ updatedAt: {
2999
+ format: 'date-time',
3000
+ type: 'string',
3001
+ description: 'Last update timestamp',
3002
+ example: '2024-11-03T10:00:00Z'
3003
+ }
3004
+ },
3005
+ required: [
3006
+ 'id',
3007
+ 'userId',
3008
+ 'currency',
3009
+ 'quoteCurrency',
3010
+ 'amount',
3011
+ 'date',
3012
+ 'meta',
3013
+ 'createdAt',
3014
+ 'updatedAt'
3015
+ ]
3016
+ } as const;
3017
+
3018
+ export const $PriceListResponseDto = {
3019
+ type: 'object',
3020
+ properties: {
3021
+ items: {
3022
+ description: 'List of prices',
3023
+ type: 'array',
3024
+ items: {
3025
+ $ref: '#/components/schemas/PriceResponseDto'
3026
+ }
3027
+ },
3028
+ total: {
3029
+ type: 'number',
3030
+ description: 'Total number of prices',
3031
+ example: 42
3032
+ }
3033
+ },
3034
+ required: ['items', 'total']
3035
+ } as const;
3036
+
3037
+ export const $UpdateBeanPriceDto = {
3038
+ type: 'object',
3039
+ properties: {
3040
+ currency: {
3041
+ type: 'string',
3042
+ description: 'Currency being priced'
3043
+ },
3044
+ quoteCurrency: {
3045
+ type: 'string',
3046
+ description: 'Quote currency (pricing currency)'
3047
+ },
3048
+ amount: {
3049
+ type: 'number',
3050
+ description: 'Price amount (MUST be >= 0 per Beancount spec)',
3051
+ minimum: 0
3052
+ },
3053
+ date: {
3054
+ type: 'string',
3055
+ description: 'Price date (ISO 8601 format)'
3056
+ },
3057
+ metadata: {
3058
+ type: 'object',
3059
+ description: 'Metadata'
3060
+ }
3061
+ }
3062
+ } as const;
3063
+
3064
+ export const $CreateRecurringRuleDto = {
3065
+ type: 'object',
3066
+ properties: {
3067
+ name: {
3068
+ type: 'string',
3069
+ description: 'Rule name (unique per user)',
3070
+ maxLength: 100
3071
+ },
3072
+ icon: {
3073
+ type: 'string',
3074
+ description: 'Icon emoji',
3075
+ maxLength: 10
3076
+ },
3077
+ frequency: {
3078
+ type: 'string',
3079
+ description: 'Recurring frequency',
3080
+ enum: [
3081
+ 'WEEKLY',
3082
+ 'BIWEEKLY',
3083
+ 'MONTHLY',
3084
+ 'BIMONTHLY',
3085
+ 'QUARTERLY',
3086
+ 'YEARLY',
3087
+ 'CUSTOM'
3088
+ ]
3089
+ },
3090
+ expectedAmount: {
3091
+ type: 'number',
3092
+ description: 'Expected amount (positive number)',
3093
+ minimum: 0
3094
+ },
3095
+ expectedDay: {
3096
+ type: 'number',
3097
+ description: 'Expected day of month (1-31)',
3098
+ minimum: 1,
3099
+ maximum: 31
3100
+ },
3101
+ customIntervalDays: {
3102
+ type: 'number',
3103
+ description: 'Custom interval in days (required for CUSTOM frequency)',
3104
+ minimum: 1
3105
+ },
3106
+ currency: {
3107
+ type: 'string',
3108
+ description: 'Currency code',
3109
+ default: 'CNY',
3110
+ maxLength: 10
3111
+ },
3112
+ matchPayeePattern: {
3113
+ type: 'string',
3114
+ description: 'Payee matching pattern (supports wildcards)',
3115
+ maxLength: 200
3116
+ },
3117
+ matchAmountTolerance: {
3118
+ type: 'number',
3119
+ description: 'Amount tolerance percentage (0-1)',
3120
+ default: 0.075,
3121
+ minimum: 0,
2805
3122
  maximum: 1
2806
3123
  },
2807
3124
  defaultExpenseAccount: {
@@ -3515,307 +3832,754 @@ export const $ForecastResponseDto = {
3515
3832
  ]
3516
3833
  } as const;
3517
3834
 
3518
- export const $CreateTransactionRuleDto = {
3835
+ export const $CurrencyBalanceDto = {
3519
3836
  type: 'object',
3520
3837
  properties: {
3521
- name: {
3838
+ currency: {
3522
3839
  type: 'string',
3523
- minLength: 1,
3524
- maxLength: 100
3840
+ description: 'ISO 4217 currency code',
3841
+ example: 'CNY'
3525
3842
  },
3526
- description: {
3843
+ balance: {
3527
3844
  type: 'string',
3528
- maxLength: 500
3529
- },
3530
- narrationKeywords: {
3531
- items: {
3532
- type: 'array'
3533
- },
3534
- maxItems: 50,
3535
- type: 'array'
3536
- },
3537
- payeeKeywords: {
3538
- items: {
3539
- type: 'array'
3540
- },
3541
- maxItems: 50,
3542
- type: 'array'
3543
- },
3544
- categoryKeywords: {
3545
- items: {
3546
- type: 'array'
3547
- },
3548
- maxItems: 50,
3549
- type: 'array'
3550
- },
3551
- methodKeywords: {
3552
- items: {
3553
- type: 'array'
3554
- },
3555
- maxItems: 50,
3556
- description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
3557
- type: 'array'
3558
- },
3559
- categoryAccount: {
3845
+ description: 'Balance amount',
3846
+ example: '500000.00'
3847
+ }
3848
+ },
3849
+ required: ['currency', 'balance']
3850
+ } as const;
3851
+
3852
+ export const $TimeSeriesPointDto = {
3853
+ type: 'object',
3854
+ properties: {
3855
+ date: {
3560
3856
  type: 'string',
3561
- maxLength: 200,
3562
- description:
3563
- 'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
3857
+ description: 'Date in YYYY-MM-DD format',
3858
+ example: '2024-06-15'
3564
3859
  },
3565
- matchLogic: {
3860
+ value: {
3566
3861
  type: 'string',
3567
- enum: ['OR', 'AND'],
3568
- default: 'OR'
3862
+ description: 'Value at this date (in base currency)',
3863
+ example: '500000.00'
3569
3864
  },
3570
- amountMin: {
3571
- type: 'number',
3572
- minimum: 0,
3573
- description: 'Minimum transaction amount (inclusive)'
3865
+ change: {
3866
+ type: 'object',
3867
+ description: 'Change from previous point',
3868
+ example: '5000.00'
3574
3869
  },
3575
- amountMax: {
3576
- type: 'number',
3577
- minimum: 0,
3578
- description: 'Maximum transaction amount (inclusive)'
3870
+ assets: {
3871
+ type: 'string',
3872
+ description: 'Total assets at this date (in base currency)',
3873
+ example: '494338.00'
3579
3874
  },
3580
- priority: {
3581
- type: 'number',
3582
- default: 50,
3583
- minimum: 0,
3584
- maximum: 1000
3875
+ liabilities: {
3876
+ type: 'string',
3877
+ description: 'Total liabilities at this date (in base currency)',
3878
+ example: '310098.00'
3585
3879
  },
3586
- additionalTags: {
3880
+ byCurrency: {
3881
+ description: 'Multi-currency breakdown for this point',
3882
+ type: 'array',
3587
3883
  items: {
3588
- type: 'array'
3589
- },
3590
- maxItems: 20,
3591
- type: 'array'
3592
- },
3593
- additionalMetadata: {
3594
- type: 'object'
3595
- },
3596
- upsertByPayee: {
3597
- type: 'boolean',
3598
- description:
3599
- 'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
3884
+ $ref: '#/components/schemas/CurrencyBalanceDto'
3885
+ }
3600
3886
  }
3601
3887
  },
3602
- required: ['name', 'matchLogic', 'priority']
3888
+ required: ['date', 'value']
3603
3889
  } as const;
3604
3890
 
3605
- export const $AmountRangeDto = {
3891
+ export const $TrendSummaryDto = {
3606
3892
  type: 'object',
3607
3893
  properties: {
3608
- min: {
3609
- type: 'number',
3610
- description: 'Minimum amount'
3894
+ startValue: {
3895
+ type: 'string',
3896
+ description: 'Value at start of period',
3897
+ example: '450000.00'
3611
3898
  },
3612
- max: {
3613
- type: 'number',
3614
- description: 'Maximum amount'
3899
+ endValue: {
3900
+ type: 'string',
3901
+ description: 'Value at end of period',
3902
+ example: '500000.00'
3903
+ },
3904
+ totalChange: {
3905
+ type: 'string',
3906
+ description: 'Total change over period',
3907
+ example: '50000.00'
3908
+ },
3909
+ totalChangePercentage: {
3910
+ type: 'string',
3911
+ description: 'Total change percentage',
3912
+ example: '+11.11%'
3615
3913
  }
3616
- }
3914
+ },
3915
+ required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
3617
3916
  } as const;
3618
3917
 
3619
- export const $TransactionRuleResponseDto = {
3918
+ export const $MultiCurrencyPointDto = {
3620
3919
  type: 'object',
3621
3920
  properties: {
3622
- id: {
3623
- type: 'string',
3624
- description: 'Rule ID'
3625
- },
3626
- name: {
3627
- type: 'string',
3628
- description: 'Rule name'
3629
- },
3630
- description: {
3921
+ date: {
3631
3922
  type: 'string',
3632
- description: 'Rule description'
3633
- },
3634
- narrationKeywords: {
3635
- description: 'Keywords to match in transaction narration',
3636
- type: 'array',
3637
- items: {
3638
- type: 'string'
3639
- }
3640
- },
3641
- payeeKeywords: {
3642
- description: 'Keywords to match in payee name',
3643
- type: 'array',
3644
- items: {
3645
- type: 'string'
3646
- }
3923
+ description: 'Date in YYYY-MM-DD format',
3924
+ example: '2024-06-15'
3647
3925
  },
3648
- categoryKeywords: {
3649
- description: 'Keywords to match in category',
3926
+ byCurrency: {
3927
+ description: 'Balances by currency',
3650
3928
  type: 'array',
3651
3929
  items: {
3652
- type: 'string'
3930
+ $ref: '#/components/schemas/CurrencyBalanceDto'
3653
3931
  }
3654
- },
3655
- methodKeywords: {
3656
- description: 'Keywords to match in payment method',
3932
+ }
3933
+ },
3934
+ required: ['date', 'byCurrency']
3935
+ } as const;
3936
+
3937
+ export const $PortfolioTrendsResponseDto = {
3938
+ type: 'object',
3939
+ properties: {
3940
+ series: {
3941
+ description: 'Time series data points',
3657
3942
  type: 'array',
3658
3943
  items: {
3659
- type: 'string'
3944
+ $ref: '#/components/schemas/TimeSeriesPointDto'
3660
3945
  }
3661
3946
  },
3662
- categoryAccount: {
3663
- type: 'string',
3664
- description: 'Destination account for categorization'
3665
- },
3666
- matchLogic: {
3667
- type: 'string',
3668
- description: 'Keyword matching logic',
3669
- enum: ['OR', 'AND'],
3670
- example: 'OR'
3671
- },
3672
- amountRange: {
3673
- description: 'Amount range for matching',
3947
+ summary: {
3948
+ description: 'Period summary',
3674
3949
  allOf: [
3675
3950
  {
3676
- $ref: '#/components/schemas/AmountRangeDto'
3951
+ $ref: '#/components/schemas/TrendSummaryDto'
3677
3952
  }
3678
3953
  ]
3679
3954
  },
3680
- priority: {
3681
- type: 'number',
3682
- description: 'Rule priority (0-1000, higher = first match)',
3683
- example: 50
3684
- },
3685
- enabled: {
3686
- type: 'boolean',
3687
- description: 'Whether the rule is enabled'
3688
- },
3689
- learningSource: {
3955
+ period: {
3690
3956
  type: 'string',
3691
- description: 'Learning source: NLP, REVIEW_CENTER, or null for manual',
3692
- enum: ['NLP', 'REVIEW_CENTER'],
3693
- nullable: true,
3694
- example: 'REVIEW_CENTER'
3957
+ description: 'Period requested',
3958
+ example: '6m'
3695
3959
  },
3696
- autoApplyEnabled: {
3697
- type: 'boolean',
3698
- description: 'Whether auto-apply is enabled for this rule'
3960
+ granularity: {
3961
+ type: 'string',
3962
+ description: 'Data granularity',
3963
+ example: 'month'
3699
3964
  },
3700
- confirmationCount: {
3701
- type: 'number',
3702
- description: 'Number of confirmations for NLP-learned rules',
3703
- example: 3
3965
+ currency: {
3966
+ type: 'string',
3967
+ description: 'Base currency for converted values',
3968
+ example: 'CNY'
3704
3969
  },
3705
- additionalTags: {
3706
- description: 'Additional tags',
3970
+ byCurrency: {
3971
+ description:
3972
+ 'Multi-currency time series (each point has currency breakdown)',
3707
3973
  type: 'array',
3708
3974
  items: {
3709
- type: 'string'
3975
+ $ref: '#/components/schemas/MultiCurrencyPointDto'
3710
3976
  }
3711
3977
  },
3712
- additionalMetadata: {
3713
- type: 'object',
3714
- description: 'Additional metadata',
3715
- additionalProperties: {
3716
- type: 'string'
3978
+ warnings: {
3979
+ description: 'Exchange rate warnings',
3980
+ type: 'array',
3981
+ items: {
3982
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
3717
3983
  }
3718
- },
3719
- createdAt: {
3720
- format: 'date-time',
3721
- type: 'string',
3722
- description: 'Created timestamp'
3723
- },
3724
- updatedAt: {
3725
- format: 'date-time',
3726
- type: 'string',
3727
- description: 'Updated timestamp'
3728
3984
  }
3729
3985
  },
3730
- required: [
3731
- 'id',
3732
- 'name',
3733
- 'narrationKeywords',
3734
- 'payeeKeywords',
3735
- 'categoryKeywords',
3736
- 'methodKeywords',
3737
- 'matchLogic',
3738
- 'priority',
3739
- 'enabled',
3740
- 'autoApplyEnabled',
3741
- 'confirmationCount',
3742
- 'additionalTags',
3743
- 'createdAt',
3744
- 'updatedAt'
3745
- ]
3986
+ required: ['series', 'summary', 'period', 'granularity', 'currency']
3746
3987
  } as const;
3747
3988
 
3748
- export const $TransactionRuleListResponseDto = {
3989
+ export const $CashFlowPointDto = {
3749
3990
  type: 'object',
3750
3991
  properties: {
3751
- data: {
3752
- type: 'array',
3753
- items: {
3754
- $ref: '#/components/schemas/TransactionRuleResponseDto'
3755
- }
3992
+ month: {
3993
+ type: 'string',
3994
+ description: 'Month key (YYYY-MM)',
3995
+ example: '2024-03'
3756
3996
  },
3757
- total: {
3758
- type: 'number',
3759
- description: 'Total count of rules'
3997
+ income: {
3998
+ type: 'string',
3999
+ description: 'Income in base currency (absolute, converted)',
4000
+ example: '10000.00'
3760
4001
  },
3761
- limit: {
3762
- type: 'number',
3763
- description: 'Results per page'
4002
+ expense: {
4003
+ type: 'string',
4004
+ description: 'Expense in base currency (absolute, converted)',
4005
+ example: '5000.00'
3764
4006
  },
3765
- offset: {
3766
- type: 'number',
3767
- description: 'Pagination offset'
4007
+ netSavings: {
4008
+ type: 'string',
4009
+ description: 'netSavings = income − expense (savings positive)',
4010
+ example: '5000.00'
3768
4011
  }
3769
4012
  },
3770
- required: ['data', 'total', 'limit', 'offset']
4013
+ required: ['month', 'income', 'expense', 'netSavings']
3771
4014
  } as const;
3772
4015
 
3773
- export const $ValidateRuleDto = {
4016
+ export const $CashFlowTrendSummaryDto = {
3774
4017
  type: 'object',
3775
4018
  properties: {
3776
- name: {
4019
+ totalIncome: {
3777
4020
  type: 'string',
3778
- minLength: 1,
3779
- maxLength: 100
4021
+ description: 'Total income across the period',
4022
+ example: '60000.00'
3780
4023
  },
3781
- description: {
4024
+ totalExpense: {
3782
4025
  type: 'string',
3783
- maxLength: 500
3784
- },
3785
- narrationKeywords: {
3786
- items: {
3787
- type: 'array'
3788
- },
3789
- maxItems: 50,
3790
- type: 'array'
4026
+ description: 'Total expense across the period',
4027
+ example: '30000.00'
3791
4028
  },
3792
- payeeKeywords: {
3793
- items: {
3794
- type: 'array'
3795
- },
3796
- maxItems: 50,
3797
- type: 'array'
4029
+ totalNetSavings: {
4030
+ type: 'string',
4031
+ description: 'income − expense across the period',
4032
+ example: '30000.00'
3798
4033
  },
3799
- categoryKeywords: {
4034
+ averageMonthlyNetSavings: {
4035
+ type: 'string',
4036
+ description:
4037
+ 'totalNetSavings divided by the window length (N months, incl. zero-filled)',
4038
+ example: '5000.00'
4039
+ }
4040
+ },
4041
+ required: [
4042
+ 'totalIncome',
4043
+ 'totalExpense',
4044
+ 'totalNetSavings',
4045
+ 'averageMonthlyNetSavings'
4046
+ ]
4047
+ } as const;
4048
+
4049
+ export const $CashFlowTrendsResponseDto = {
4050
+ type: 'object',
4051
+ properties: {
4052
+ series: {
4053
+ description:
4054
+ 'Monthly cash-flow series (fixed N-month window, zero-filled)',
4055
+ type: 'array',
3800
4056
  items: {
3801
- type: 'array'
3802
- },
3803
- maxItems: 50,
3804
- type: 'array'
4057
+ $ref: '#/components/schemas/CashFlowPointDto'
4058
+ }
3805
4059
  },
3806
- methodKeywords: {
3807
- items: {
3808
- type: 'array'
3809
- },
3810
- maxItems: 50,
3811
- description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
3812
- type: 'array'
4060
+ summary: {
4061
+ description: 'Period totals',
4062
+ allOf: [
4063
+ {
4064
+ $ref: '#/components/schemas/CashFlowTrendSummaryDto'
4065
+ }
4066
+ ]
3813
4067
  },
3814
- categoryAccount: {
4068
+ period: {
3815
4069
  type: 'string',
3816
- maxLength: 200,
3817
- description:
3818
- 'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
4070
+ description: 'Period requested',
4071
+ example: '6m'
4072
+ },
4073
+ granularity: {
4074
+ type: 'string',
4075
+ description: 'Data granularity (v1 returns month buckets)',
4076
+ example: 'month'
4077
+ },
4078
+ currency: {
4079
+ type: 'string',
4080
+ description: 'Base currency for converted values',
4081
+ example: 'CNY'
4082
+ },
4083
+ warnings: {
4084
+ description: 'Exchange rate warnings (e.g. missing rate for a currency)',
4085
+ type: 'array',
4086
+ items: {
4087
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
4088
+ }
4089
+ }
4090
+ },
4091
+ required: ['series', 'summary', 'period', 'granularity', 'currency']
4092
+ } as const;
4093
+
4094
+ export const $GenerateSnapshotBody = {
4095
+ type: 'object',
4096
+ properties: {}
4097
+ } as const;
4098
+
4099
+ export const $GenerateSnapshotResponse = {
4100
+ type: 'object',
4101
+ properties: {}
4102
+ } as const;
4103
+
4104
+ export const $BackfillSnapshotsBody = {
4105
+ type: 'object',
4106
+ properties: {}
4107
+ } as const;
4108
+
4109
+ export const $BackfillSnapshotsResponse = {
4110
+ type: 'object',
4111
+ properties: {}
4112
+ } as const;
4113
+
4114
+ export const $DeleteOwnUserDto = {
4115
+ type: 'object',
4116
+ properties: {
4117
+ accessToken: {
4118
+ type: 'string',
4119
+ description: 'Access token for user verification',
4120
+ example: 'abc123xyz'
4121
+ }
4122
+ },
4123
+ required: ['accessToken']
4124
+ } as const;
4125
+
4126
+ export const $SignupDto = {
4127
+ type: 'object',
4128
+ properties: {
4129
+ turnstileToken: {
4130
+ type: 'string',
4131
+ description:
4132
+ 'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
4133
+ example: '0.abc123def456...'
4134
+ }
4135
+ }
4136
+ } as const;
4137
+
4138
+ export const $SignupResponseDto = {
4139
+ type: 'object',
4140
+ properties: {
4141
+ authToken: {
4142
+ type: 'string',
4143
+ description: 'JWT auth token',
4144
+ example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
4145
+ },
4146
+ accessToken: {
4147
+ type: 'string',
4148
+ description: 'Auto-generated access token'
4149
+ },
4150
+ role: {
4151
+ type: 'string',
4152
+ description: 'Assigned user role',
4153
+ enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
4154
+ }
4155
+ },
4156
+ required: ['authToken', 'accessToken', 'role']
4157
+ } as const;
4158
+
4159
+ export const $UpdateUserSettingDto = {
4160
+ type: 'object',
4161
+ properties: {
4162
+ secId: {
4163
+ type: 'number',
4164
+ description: 'Security ID'
4165
+ },
4166
+ annualInterestRate: {
4167
+ type: 'number',
4168
+ description: 'Annual interest rate',
4169
+ example: 0.05
4170
+ },
4171
+ currency: {
4172
+ type: 'string',
4173
+ description: 'Currency code',
4174
+ example: 'USD'
4175
+ },
4176
+ baseCurrency: {
4177
+ type: 'string',
4178
+ description: 'Base currency code',
4179
+ example: 'USD'
4180
+ },
4181
+ benchmark: {
4182
+ type: 'string',
4183
+ description: 'Benchmark symbol',
4184
+ example: 'SPY'
4185
+ },
4186
+ colorScheme: {
4187
+ type: 'string',
4188
+ description: 'Color scheme',
4189
+ enum: ['DARK', 'LIGHT']
4190
+ },
4191
+ dateRange: {
4192
+ type: 'string',
4193
+ description: 'Date range filter',
4194
+ example: '1y'
4195
+ },
4196
+ emergencyFund: {
4197
+ type: 'number',
4198
+ description: 'Emergency fund amount',
4199
+ example: 10000
4200
+ },
4201
+ 'filters.accounts': {
4202
+ description: 'Account filter IDs',
4203
+ type: 'array',
4204
+ items: {
4205
+ type: 'string'
4206
+ }
4207
+ },
4208
+ 'filters.assetClasses': {
4209
+ description: 'Asset class filters',
4210
+ type: 'array',
4211
+ items: {
4212
+ type: 'string'
4213
+ }
4214
+ },
4215
+ 'filters.dataSource': {
4216
+ type: 'string',
4217
+ description: 'Data source filter'
4218
+ },
4219
+ 'filters.symbol': {
4220
+ type: 'string',
4221
+ description: 'Symbol filter'
4222
+ },
4223
+ 'filters.tags': {
4224
+ description: 'Tag filters',
4225
+ type: 'array',
4226
+ items: {
4227
+ type: 'string'
4228
+ }
4229
+ },
4230
+ isExperimentalFeatures: {
4231
+ type: 'boolean',
4232
+ description: 'Enable experimental features'
4233
+ },
4234
+ isRestrictedView: {
4235
+ type: 'boolean',
4236
+ description: 'Enable restricted view mode'
4237
+ },
4238
+ language: {
4239
+ type: 'string',
4240
+ description: 'Language code',
4241
+ example: 'en'
4242
+ },
4243
+ locale: {
4244
+ type: 'string',
4245
+ description: 'Locale code',
4246
+ example: 'en-US'
4247
+ },
4248
+ projectedTotalAmount: {
4249
+ type: 'number',
4250
+ description: 'Projected total amount',
4251
+ example: 1000000
4252
+ },
4253
+ retirementDate: {
4254
+ type: 'string',
4255
+ description: 'Retirement date in ISO 8601 format',
4256
+ example: '2050-01-01'
4257
+ },
4258
+ savingsRate: {
4259
+ type: 'number',
4260
+ description: 'Savings rate percentage',
4261
+ example: 0.2
4262
+ },
4263
+ viewMode: {
4264
+ type: 'string',
4265
+ description: 'View mode',
4266
+ enum: ['DEFAULT', 'ZEN']
4267
+ }
4268
+ }
4269
+ } as const;
4270
+
4271
+ export const $UpdatePropertyDto = {
4272
+ type: 'object',
4273
+ properties: {
4274
+ value: {
4275
+ type: 'string',
4276
+ description: 'Property value'
4277
+ }
4278
+ },
4279
+ required: ['value']
4280
+ } as const;
4281
+
4282
+ export const $CreateTransactionRuleDto = {
4283
+ type: 'object',
4284
+ properties: {
4285
+ name: {
4286
+ type: 'string',
4287
+ minLength: 1,
4288
+ maxLength: 100
4289
+ },
4290
+ description: {
4291
+ type: 'string',
4292
+ maxLength: 500
4293
+ },
4294
+ narrationKeywords: {
4295
+ items: {
4296
+ type: 'array'
4297
+ },
4298
+ maxItems: 50,
4299
+ type: 'array'
4300
+ },
4301
+ payeeKeywords: {
4302
+ items: {
4303
+ type: 'array'
4304
+ },
4305
+ maxItems: 50,
4306
+ type: 'array'
4307
+ },
4308
+ categoryKeywords: {
4309
+ items: {
4310
+ type: 'array'
4311
+ },
4312
+ maxItems: 50,
4313
+ type: 'array'
4314
+ },
4315
+ methodKeywords: {
4316
+ items: {
4317
+ type: 'array'
4318
+ },
4319
+ maxItems: 50,
4320
+ description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
4321
+ type: 'array'
4322
+ },
4323
+ categoryAccount: {
4324
+ type: 'string',
4325
+ maxLength: 200,
4326
+ description:
4327
+ 'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
4328
+ },
4329
+ matchLogic: {
4330
+ type: 'string',
4331
+ enum: ['OR', 'AND'],
4332
+ default: 'OR'
4333
+ },
4334
+ amountMin: {
4335
+ type: 'number',
4336
+ minimum: 0,
4337
+ description: 'Minimum transaction amount (inclusive)'
4338
+ },
4339
+ amountMax: {
4340
+ type: 'number',
4341
+ minimum: 0,
4342
+ description: 'Maximum transaction amount (inclusive)'
4343
+ },
4344
+ priority: {
4345
+ type: 'number',
4346
+ default: 50,
4347
+ minimum: 0,
4348
+ maximum: 1000
4349
+ },
4350
+ additionalTags: {
4351
+ items: {
4352
+ type: 'array'
4353
+ },
4354
+ maxItems: 20,
4355
+ type: 'array'
4356
+ },
4357
+ additionalMetadata: {
4358
+ type: 'object'
4359
+ },
4360
+ upsertByPayee: {
4361
+ type: 'boolean',
4362
+ description:
4363
+ 'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
4364
+ }
4365
+ },
4366
+ required: ['name', 'matchLogic', 'priority']
4367
+ } as const;
4368
+
4369
+ export const $AmountRangeDto = {
4370
+ type: 'object',
4371
+ properties: {
4372
+ min: {
4373
+ type: 'number',
4374
+ description: 'Minimum amount'
4375
+ },
4376
+ max: {
4377
+ type: 'number',
4378
+ description: 'Maximum amount'
4379
+ }
4380
+ }
4381
+ } as const;
4382
+
4383
+ export const $TransactionRuleResponseDto = {
4384
+ type: 'object',
4385
+ properties: {
4386
+ id: {
4387
+ type: 'string',
4388
+ description: 'Rule ID'
4389
+ },
4390
+ name: {
4391
+ type: 'string',
4392
+ description: 'Rule name'
4393
+ },
4394
+ description: {
4395
+ type: 'string',
4396
+ description: 'Rule description'
4397
+ },
4398
+ narrationKeywords: {
4399
+ description: 'Keywords to match in transaction narration',
4400
+ type: 'array',
4401
+ items: {
4402
+ type: 'string'
4403
+ }
4404
+ },
4405
+ payeeKeywords: {
4406
+ description: 'Keywords to match in payee name',
4407
+ type: 'array',
4408
+ items: {
4409
+ type: 'string'
4410
+ }
4411
+ },
4412
+ categoryKeywords: {
4413
+ description: 'Keywords to match in category',
4414
+ type: 'array',
4415
+ items: {
4416
+ type: 'string'
4417
+ }
4418
+ },
4419
+ methodKeywords: {
4420
+ description: 'Keywords to match in payment method',
4421
+ type: 'array',
4422
+ items: {
4423
+ type: 'string'
4424
+ }
4425
+ },
4426
+ categoryAccount: {
4427
+ type: 'string',
4428
+ description: 'Destination account for categorization'
4429
+ },
4430
+ matchLogic: {
4431
+ type: 'string',
4432
+ description: 'Keyword matching logic',
4433
+ enum: ['OR', 'AND'],
4434
+ example: 'OR'
4435
+ },
4436
+ amountRange: {
4437
+ description: 'Amount range for matching',
4438
+ allOf: [
4439
+ {
4440
+ $ref: '#/components/schemas/AmountRangeDto'
4441
+ }
4442
+ ]
4443
+ },
4444
+ priority: {
4445
+ type: 'number',
4446
+ description: 'Rule priority (0-1000, higher = first match)',
4447
+ example: 50
4448
+ },
4449
+ enabled: {
4450
+ type: 'boolean',
4451
+ description: 'Whether the rule is enabled'
4452
+ },
4453
+ learningSource: {
4454
+ type: 'string',
4455
+ description: 'Learning source: NLP, REVIEW_CENTER, or null for manual',
4456
+ enum: ['NLP', 'REVIEW_CENTER'],
4457
+ nullable: true,
4458
+ example: 'REVIEW_CENTER'
4459
+ },
4460
+ autoApplyEnabled: {
4461
+ type: 'boolean',
4462
+ description: 'Whether auto-apply is enabled for this rule'
4463
+ },
4464
+ confirmationCount: {
4465
+ type: 'number',
4466
+ description: 'Number of confirmations for NLP-learned rules',
4467
+ example: 3
4468
+ },
4469
+ additionalTags: {
4470
+ description: 'Additional tags',
4471
+ type: 'array',
4472
+ items: {
4473
+ type: 'string'
4474
+ }
4475
+ },
4476
+ additionalMetadata: {
4477
+ type: 'object',
4478
+ description: 'Additional metadata',
4479
+ additionalProperties: {
4480
+ type: 'string'
4481
+ }
4482
+ },
4483
+ createdAt: {
4484
+ format: 'date-time',
4485
+ type: 'string',
4486
+ description: 'Created timestamp'
4487
+ },
4488
+ updatedAt: {
4489
+ format: 'date-time',
4490
+ type: 'string',
4491
+ description: 'Updated timestamp'
4492
+ }
4493
+ },
4494
+ required: [
4495
+ 'id',
4496
+ 'name',
4497
+ 'narrationKeywords',
4498
+ 'payeeKeywords',
4499
+ 'categoryKeywords',
4500
+ 'methodKeywords',
4501
+ 'matchLogic',
4502
+ 'priority',
4503
+ 'enabled',
4504
+ 'autoApplyEnabled',
4505
+ 'confirmationCount',
4506
+ 'additionalTags',
4507
+ 'createdAt',
4508
+ 'updatedAt'
4509
+ ]
4510
+ } as const;
4511
+
4512
+ export const $TransactionRuleListResponseDto = {
4513
+ type: 'object',
4514
+ properties: {
4515
+ data: {
4516
+ type: 'array',
4517
+ items: {
4518
+ $ref: '#/components/schemas/TransactionRuleResponseDto'
4519
+ }
4520
+ },
4521
+ total: {
4522
+ type: 'number',
4523
+ description: 'Total count of rules'
4524
+ },
4525
+ limit: {
4526
+ type: 'number',
4527
+ description: 'Results per page'
4528
+ },
4529
+ offset: {
4530
+ type: 'number',
4531
+ description: 'Pagination offset'
4532
+ }
4533
+ },
4534
+ required: ['data', 'total', 'limit', 'offset']
4535
+ } as const;
4536
+
4537
+ export const $ValidateRuleDto = {
4538
+ type: 'object',
4539
+ properties: {
4540
+ name: {
4541
+ type: 'string',
4542
+ minLength: 1,
4543
+ maxLength: 100
4544
+ },
4545
+ description: {
4546
+ type: 'string',
4547
+ maxLength: 500
4548
+ },
4549
+ narrationKeywords: {
4550
+ items: {
4551
+ type: 'array'
4552
+ },
4553
+ maxItems: 50,
4554
+ type: 'array'
4555
+ },
4556
+ payeeKeywords: {
4557
+ items: {
4558
+ type: 'array'
4559
+ },
4560
+ maxItems: 50,
4561
+ type: 'array'
4562
+ },
4563
+ categoryKeywords: {
4564
+ items: {
4565
+ type: 'array'
4566
+ },
4567
+ maxItems: 50,
4568
+ type: 'array'
4569
+ },
4570
+ methodKeywords: {
4571
+ items: {
4572
+ type: 'array'
4573
+ },
4574
+ maxItems: 50,
4575
+ description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
4576
+ type: 'array'
4577
+ },
4578
+ categoryAccount: {
4579
+ type: 'string',
4580
+ maxLength: 200,
4581
+ description:
4582
+ 'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
3819
4583
  },
3820
4584
  matchLogic: {
3821
4585
  type: 'string',
@@ -4164,151 +4928,393 @@ export const $TestRuleResponseDto = {
4164
4928
  required: ['ruleId', 'matches', 'confidence', 'matchDetails']
4165
4929
  } as const;
4166
4930
 
4167
- export const $DeleteOwnUserDto = {
4931
+ export const $CreateBeanEventDto = {
4168
4932
  type: 'object',
4169
4933
  properties: {
4170
- accessToken: {
4934
+ date: {
4171
4935
  type: 'string',
4172
- description: 'Access token for user verification',
4173
- example: 'abc123xyz'
4936
+ description: 'Life event date (ISO 8601)',
4937
+ example: '2024-03-15'
4938
+ },
4939
+ type: {
4940
+ type: 'string',
4941
+ description:
4942
+ 'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
4943
+ example: 'employer'
4944
+ },
4945
+ description: {
4946
+ type: 'string',
4947
+ description:
4948
+ 'Life event description. Empty string is a VALID value (distinct from absence).',
4949
+ example: 'Acme Corp'
4950
+ },
4951
+ meta: {
4952
+ type: 'object',
4953
+ description:
4954
+ 'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
4955
+ example: {
4956
+ note: 'Promotion'
4957
+ }
4174
4958
  }
4175
4959
  },
4176
- required: ['accessToken']
4960
+ required: ['date', 'type', 'description']
4177
4961
  } as const;
4178
4962
 
4179
- export const $SignupDto = {
4963
+ export const $EventResponseDto = {
4180
4964
  type: 'object',
4181
4965
  properties: {
4182
- turnstileToken: {
4966
+ id: {
4967
+ type: 'string',
4968
+ description: 'Unique identifier',
4969
+ example: 'uuid-123-456'
4970
+ },
4971
+ userId: {
4972
+ type: 'string',
4973
+ description: 'User ID (owner of the life event)',
4974
+ example: 'user-123'
4975
+ },
4976
+ date: {
4977
+ type: 'string',
4978
+ description: 'Life event date (ISO 8601 format)',
4979
+ example: '2024-03-15',
4980
+ format: 'date'
4981
+ },
4982
+ type: {
4183
4983
  type: 'string',
4184
4984
  description:
4185
- 'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
4186
- example: '0.abc123def456...'
4985
+ 'Life event type (user-defined, e.g., "employer", "location")',
4986
+ example: 'employer'
4987
+ },
4988
+ description: {
4989
+ type: 'string',
4990
+ description:
4991
+ 'Life event description. May be an empty string (a valid value distinct from absence).',
4992
+ example: 'Acme Corp'
4993
+ },
4994
+ meta: {
4995
+ type: 'object',
4996
+ description: 'Product-side metadata (free-form JSON)',
4997
+ example: {
4998
+ note: 'Promotion'
4999
+ }
5000
+ },
5001
+ createdAt: {
5002
+ format: 'date-time',
5003
+ type: 'string',
5004
+ description: 'Creation timestamp',
5005
+ example: '2024-03-15T10:00:00Z'
5006
+ },
5007
+ updatedAt: {
5008
+ format: 'date-time',
5009
+ type: 'string',
5010
+ description:
5011
+ 'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
5012
+ example: '2024-03-15T10:00:00Z'
4187
5013
  }
4188
- }
5014
+ },
5015
+ required: [
5016
+ 'id',
5017
+ 'userId',
5018
+ 'date',
5019
+ 'type',
5020
+ 'description',
5021
+ 'meta',
5022
+ 'createdAt',
5023
+ 'updatedAt'
5024
+ ]
4189
5025
  } as const;
4190
5026
 
4191
- export const $UpdateUserSettingDto = {
5027
+ export const $EventListResponseDto = {
4192
5028
  type: 'object',
4193
5029
  properties: {
4194
- secId: {
4195
- type: 'number',
4196
- description: 'Security ID'
5030
+ items: {
5031
+ description: 'List of life events',
5032
+ type: 'array',
5033
+ items: {
5034
+ $ref: '#/components/schemas/EventResponseDto'
5035
+ }
4197
5036
  },
4198
- annualInterestRate: {
5037
+ total: {
4199
5038
  type: 'number',
4200
- description: 'Annual interest rate',
4201
- example: 0.05
5039
+ description: 'Total number of life events matching the query',
5040
+ example: 42
5041
+ }
5042
+ },
5043
+ required: ['items', 'total']
5044
+ } as const;
5045
+
5046
+ export const $UpdateBeanEventDto = {
5047
+ type: 'object',
5048
+ properties: {
5049
+ date: {
5050
+ type: 'string',
5051
+ description: 'Life event date (ISO 8601)'
5052
+ },
5053
+ type: {
5054
+ type: 'string',
5055
+ description: 'Life event type (user-defined)'
5056
+ },
5057
+ description: {
5058
+ type: 'string',
5059
+ description:
5060
+ 'Life event description. Empty string is a VALID value (distinct from absence).'
5061
+ },
5062
+ meta: {
5063
+ type: 'object',
5064
+ description: 'Product-side metadata (free-form JSON)'
5065
+ }
5066
+ }
5067
+ } as const;
5068
+
5069
+ export const $OnboardingAccountDto = {
5070
+ type: 'object',
5071
+ properties: {
5072
+ path: {
5073
+ type: 'string',
5074
+ description:
5075
+ 'Account path (Assets/Liabilities only; format validated by the account service)',
5076
+ example: 'Assets:Checking'
4202
5077
  },
4203
5078
  currency: {
4204
5079
  type: 'string',
4205
- description: 'Currency code',
5080
+ description: 'ISO 4217 currency code (3 letters)',
4206
5081
  example: 'USD'
4207
5082
  },
4208
- baseCurrency: {
5083
+ openingBalance: {
5084
+ type: 'string',
5085
+ description:
5086
+ 'Opening balance as a non-negative Decimal string (e.g. "1000.00")',
5087
+ example: '1000.00'
5088
+ },
5089
+ platformId: {
5090
+ type: 'string',
5091
+ description:
5092
+ 'Platform ID to bind the account to (references Platform.id); omit for unbound',
5093
+ example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
5094
+ }
5095
+ },
5096
+ required: ['path', 'currency']
5097
+ } as const;
5098
+
5099
+ export const $OnboardingDto = {
5100
+ type: 'object',
5101
+ properties: {
5102
+ accounts: {
5103
+ description: 'Asset/Liability accounts to register with opening balances',
5104
+ type: 'array',
5105
+ items: {
5106
+ $ref: '#/components/schemas/OnboardingAccountDto'
5107
+ }
5108
+ },
5109
+ skipAssetRegistration: {
5110
+ type: 'boolean',
5111
+ description:
5112
+ 'Skip asset registration; only bootstrap the core account set',
5113
+ default: false
5114
+ }
5115
+ }
5116
+ } as const;
5117
+
5118
+ export const $ActualBalanceDto = {
5119
+ type: 'object',
5120
+ properties: {
5121
+ amount: {
5122
+ type: 'string',
5123
+ description:
5124
+ 'Actual balance amount as a decimal string (preserves precision for tolerance inference).',
5125
+ example: '1234.56'
5126
+ },
5127
+ ccy: {
5128
+ type: 'string',
5129
+ description: 'Currency code (ISO 4217 or commodity ticker).',
5130
+ example: 'CNY'
5131
+ }
5132
+ },
5133
+ required: ['amount', 'ccy']
5134
+ } as const;
5135
+
5136
+ export const $ComputeReconciliationDto = {
5137
+ type: 'object',
5138
+ properties: {
5139
+ accountId: {
5140
+ type: 'string',
5141
+ description: 'BeanAccount id to reconcile.'
5142
+ },
5143
+ asOfDate: {
5144
+ type: 'string',
5145
+ description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
5146
+ example: '2026-07-24'
5147
+ },
5148
+ actualBalance: {
5149
+ description: 'Actual balance from the external statement.',
5150
+ allOf: [
5151
+ {
5152
+ $ref: '#/components/schemas/ActualBalanceDto'
5153
+ }
5154
+ ]
5155
+ }
5156
+ },
5157
+ required: ['accountId', 'asOfDate', 'actualBalance']
5158
+ } as const;
5159
+
5160
+ export const $ReconciliationComputeResultDto = {
5161
+ type: 'object',
5162
+ properties: {
5163
+ accountId: {
5164
+ type: 'string'
5165
+ },
5166
+ asOfDate: {
5167
+ type: 'string'
5168
+ },
5169
+ bookBalance: {
5170
+ type: 'string',
5171
+ description: 'System-computed book balance (decimal string).'
5172
+ },
5173
+ actualBalance: {
5174
+ type: 'string',
5175
+ description: 'User-entered actual balance (decimal string).'
5176
+ },
5177
+ currency: {
5178
+ type: 'string'
5179
+ },
5180
+ diff: {
5181
+ type: 'string',
5182
+ description: 'Diff = book − actual (decimal string).'
5183
+ },
5184
+ tolerance: {
5185
+ type: 'string',
5186
+ description: 'Applied tolerance (decimal string).'
5187
+ },
5188
+ withinTolerance: {
5189
+ type: 'boolean',
5190
+ description: 'true when |diff| ≤ tolerance.'
5191
+ },
5192
+ suggestedAction: {
5193
+ type: 'string',
5194
+ enum: ['assert', 'pad'],
5195
+ description:
5196
+ 'Suggested next action: assert when within tolerance, pad otherwise.'
5197
+ }
5198
+ },
5199
+ required: [
5200
+ 'accountId',
5201
+ 'asOfDate',
5202
+ 'bookBalance',
5203
+ 'actualBalance',
5204
+ 'currency',
5205
+ 'diff',
5206
+ 'tolerance',
5207
+ 'withinTolerance',
5208
+ 'suggestedAction'
5209
+ ]
5210
+ } as const;
5211
+
5212
+ export const $AssertReconciliationDto = {
5213
+ type: 'object',
5214
+ properties: {
5215
+ accountId: {
4209
5216
  type: 'string',
4210
- description: 'Base currency code',
4211
- example: 'USD'
5217
+ description: 'BeanAccount id to reconcile.'
4212
5218
  },
4213
- benchmark: {
5219
+ asOfDate: {
4214
5220
  type: 'string',
4215
- description: 'Benchmark symbol',
4216
- example: 'SPY'
5221
+ description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
5222
+ example: '2026-07-24'
4217
5223
  },
4218
- colorScheme: {
4219
- type: 'string',
4220
- description: 'Color scheme',
4221
- enum: ['DARK', 'LIGHT']
5224
+ actualBalance: {
5225
+ description: 'Actual balance from the external statement.',
5226
+ allOf: [
5227
+ {
5228
+ $ref: '#/components/schemas/ActualBalanceDto'
5229
+ }
5230
+ ]
4222
5231
  },
4223
- dateRange: {
5232
+ tolerance: {
4224
5233
  type: 'string',
4225
- description: 'Date range filter',
4226
- example: '1y'
4227
- },
4228
- emergencyFund: {
4229
- type: 'number',
4230
- description: 'Emergency fund amount',
4231
- example: 10000
4232
- },
4233
- 'filters.accounts': {
4234
- description: 'Account filter IDs',
4235
- type: 'array',
4236
- items: {
4237
- type: 'string'
4238
- }
5234
+ description:
5235
+ 'Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).',
5236
+ example: '0.01'
5237
+ }
5238
+ },
5239
+ required: ['accountId', 'asOfDate', 'actualBalance']
5240
+ } as const;
5241
+
5242
+ export const $ReconciliationRecordDto = {
5243
+ type: 'object',
5244
+ properties: {
5245
+ id: {
5246
+ type: 'string'
4239
5247
  },
4240
- 'filters.assetClasses': {
4241
- description: 'Asset class filters',
4242
- type: 'array',
4243
- items: {
4244
- type: 'string'
4245
- }
5248
+ accountId: {
5249
+ type: 'string'
4246
5250
  },
4247
- 'filters.dataSource': {
4248
- type: 'string',
4249
- description: 'Data source filter'
5251
+ date: {
5252
+ type: 'string'
4250
5253
  },
4251
- 'filters.symbol': {
5254
+ amount: {
4252
5255
  type: 'string',
4253
- description: 'Symbol filter'
4254
- },
4255
- 'filters.tags': {
4256
- description: 'Tag filters',
4257
- type: 'array',
4258
- items: {
4259
- type: 'string'
4260
- }
5256
+ description: 'Asserted (actual) amount.'
4261
5257
  },
4262
- isExperimentalFeatures: {
4263
- type: 'boolean',
4264
- description: 'Enable experimental features'
5258
+ currency: {
5259
+ type: 'string'
4265
5260
  },
4266
- isRestrictedView: {
4267
- type: 'boolean',
4268
- description: 'Enable restricted view mode'
5261
+ tolerance: {
5262
+ type: 'string'
4269
5263
  },
4270
- language: {
5264
+ diffAmount: {
4271
5265
  type: 'string',
4272
- description: 'Language code',
4273
- example: 'en'
5266
+ description: 'book − actual.'
4274
5267
  },
4275
- locale: {
4276
- type: 'string',
4277
- description: 'Locale code',
4278
- example: 'en-US'
5268
+ diffCurrency: {
5269
+ type: 'string'
4279
5270
  },
4280
- projectedTotalAmount: {
4281
- type: 'number',
4282
- description: 'Projected total amount',
4283
- example: 1000000
5271
+ createdAt: {
5272
+ type: 'string'
5273
+ }
5274
+ },
5275
+ required: ['id', 'accountId', 'date', 'amount', 'currency', 'createdAt']
5276
+ } as const;
5277
+
5278
+ export const $PadReconciliationDto = {
5279
+ type: 'object',
5280
+ properties: {
5281
+ accountId: {
5282
+ type: 'string',
5283
+ description: 'BeanAccount id to reconcile.'
4284
5284
  },
4285
- retirementDate: {
5285
+ asOfDate: {
4286
5286
  type: 'string',
4287
- description: 'Retirement date in ISO 8601 format',
4288
- example: '2050-01-01'
5287
+ description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
5288
+ example: '2026-07-24'
4289
5289
  },
4290
- savingsRate: {
4291
- type: 'number',
4292
- description: 'Savings rate percentage',
4293
- example: 0.2
5290
+ actualBalance: {
5291
+ description: 'Actual balance from the external statement.',
5292
+ allOf: [
5293
+ {
5294
+ $ref: '#/components/schemas/ActualBalanceDto'
5295
+ }
5296
+ ]
4294
5297
  },
4295
- viewMode: {
5298
+ sourceAccount: {
4296
5299
  type: 'string',
4297
- description: 'View mode',
4298
- enum: ['DEFAULT', 'ZEN']
5300
+ description:
5301
+ 'Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).',
5302
+ example: 'Equity:Opening-Balances',
5303
+ default: 'Equity:Opening-Balances'
4299
5304
  }
4300
- }
5305
+ },
5306
+ required: ['accountId', 'asOfDate', 'actualBalance']
4301
5307
  } as const;
4302
5308
 
4303
- export const $UpdatePropertyDto = {
5309
+ export const $PadResultDto = {
4304
5310
  type: 'object',
4305
5311
  properties: {
4306
- value: {
5312
+ transactionId: {
4307
5313
  type: 'string',
4308
- description: 'Property value'
5314
+ description: 'Created pad adjusting transaction id.'
4309
5315
  }
4310
5316
  },
4311
- required: ['value']
5317
+ required: ['transactionId']
4312
5318
  } as const;
4313
5319
 
4314
5320
  export const $FileImportDto = {
@@ -4477,7 +5483,7 @@ export const $IdentifyResultDto = {
4477
5483
  account: {
4478
5484
  type: 'string',
4479
5485
  description: 'Default account used by this importer',
4480
- example: 'Assets:Alipay:Balance'
5486
+ example: 'Assets:CN:Alipay:Balance'
4481
5487
  },
4482
5488
  message: {
4483
5489
  type: 'string',
@@ -4494,7 +5500,7 @@ export const $MapperDefaultsDto = {
4494
5500
  sourceAccount: {
4495
5501
  type: 'string',
4496
5502
  description: 'Source account for transactions (Beancount format)',
4497
- example: 'Assets:Alipay:Balance'
5503
+ example: 'Assets:CN:Alipay:Balance'
4498
5504
  },
4499
5505
  currency: {
4500
5506
  type: 'string',
@@ -4531,7 +5537,7 @@ export const $MapperDefaultsDto = {
4531
5537
  description:
4532
5538
  'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
4533
5539
  example: {
4534
- HuaBei: 'Liabilities:Alipay:Huabei',
5540
+ HuaBei: 'Liabilities:CN:CreditLine',
4535
5541
  CreditCard: 'Liabilities:CreditCard'
4536
5542
  }
4537
5543
  }
@@ -4663,7 +5669,7 @@ export const $UpdateMapperDefaultsDto = {
4663
5669
  sourceAccount: {
4664
5670
  type: 'string',
4665
5671
  description: 'Source account for transactions (Beancount format)',
4666
- example: 'Assets:Alipay:Balance',
5672
+ example: 'Assets:CN:Alipay:Balance',
4667
5673
  pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
4668
5674
  },
4669
5675
  currency: {
@@ -4691,7 +5697,7 @@ export const $UpdateMapperDefaultsDto = {
4691
5697
  description:
4692
5698
  'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
4693
5699
  example: {
4694
- HuaBei: 'Liabilities:Alipay:Huabei',
5700
+ HuaBei: 'Liabilities:CN:CreditLine',
4695
5701
  CreditCard: 'Liabilities:CreditCard'
4696
5702
  }
4697
5703
  }
@@ -4726,119 +5732,13 @@ export const $UpdateImporterConfigDto = {
4726
5732
  }
4727
5733
  } as const;
4728
5734
 
4729
- export const $CreatePlatformDto = {
4730
- type: 'object',
4731
- properties: {
4732
- name: {
4733
- type: 'string',
4734
- description: 'Platform name',
4735
- example: 'Binance'
4736
- },
4737
- canonical: {
4738
- type: 'string',
4739
- description: 'Platform canonical identifier (lowercase, kebab-case)',
4740
- example: 'binance'
4741
- },
4742
- aliases: {
4743
- description: 'Platform aliases (multi-language names for lookup)',
4744
- example: ['Binance', 'Binance Exchange', 'BNB'],
4745
- type: 'array',
4746
- items: {
4747
- type: 'string'
4748
- }
4749
- },
4750
- url: {
4751
- type: 'string',
4752
- description: 'Platform URL',
4753
- example: 'https://www.binance.com'
4754
- },
4755
- type: {
4756
- type: 'string',
4757
- description: 'Platform type',
4758
- enum: [
4759
- 'BANK',
4760
- 'BROKERAGE',
4761
- 'CRYPTO_EXCHANGE',
4762
- 'PAYMENT',
4763
- 'INVESTMENT',
4764
- 'INSURANCE',
4765
- 'OTHER'
4766
- ],
4767
- example: 'CRYPTO_EXCHANGE'
4768
- },
4769
- logoUrl: {
4770
- type: 'string',
4771
- description: 'Platform logo URL',
4772
- example: 'https://example.com/logos/binance.png'
4773
- },
4774
- isActive: {
4775
- type: 'boolean',
4776
- description: 'Whether the platform is active',
4777
- default: true
4778
- }
4779
- },
4780
- required: ['name', 'canonical', 'aliases', 'url', 'type']
4781
- } as const;
4782
-
4783
- export const $UpdatePlatformDto = {
4784
- type: 'object',
4785
- properties: {
4786
- name: {
4787
- type: 'string',
4788
- description: 'Platform name',
4789
- example: 'Binance'
4790
- },
4791
- canonical: {
4792
- type: 'string',
4793
- description: 'Platform canonical identifier (lowercase, kebab-case)',
4794
- example: 'binance'
4795
- },
4796
- aliases: {
4797
- description: 'Platform aliases (multi-language names for lookup)',
4798
- example: ['Binance', 'Binance Exchange', 'BNB'],
4799
- type: 'array',
4800
- items: {
4801
- type: 'string'
4802
- }
4803
- },
4804
- url: {
4805
- type: 'string',
4806
- description: 'Platform URL',
4807
- example: 'https://www.binance.com'
4808
- },
4809
- type: {
4810
- type: 'string',
4811
- description: 'Platform type',
4812
- enum: [
4813
- 'BANK',
4814
- 'BROKERAGE',
4815
- 'CRYPTO_EXCHANGE',
4816
- 'PAYMENT',
4817
- 'INVESTMENT',
4818
- 'INSURANCE',
4819
- 'OTHER'
4820
- ],
4821
- example: 'CRYPTO_EXCHANGE'
4822
- },
4823
- logoUrl: {
4824
- type: 'string',
4825
- description: 'Platform logo URL',
4826
- example: 'https://example.com/logos/binance.png'
4827
- },
4828
- isActive: {
4829
- type: 'boolean',
4830
- description: 'Whether the platform is active'
4831
- }
4832
- }
4833
- } as const;
4834
-
4835
5735
  export const $ProviderSyncConfigDto = {
4836
5736
  type: 'object',
4837
5737
  properties: {
4838
5738
  sourceAccount: {
4839
5739
  type: 'string',
4840
5740
  description: 'Source account for the first posting',
4841
- example: 'Assets:Bank:Chase'
5741
+ example: 'Assets:US:Chase:Checking'
4842
5742
  },
4843
5743
  defaultCurrency: {
4844
5744
  type: 'string',
@@ -4847,26 +5747,29 @@ export const $ProviderSyncConfigDto = {
4847
5747
  },
4848
5748
  defaultExpenseAccount: {
4849
5749
  type: 'string',
4850
- description: 'Default expense account for the second posting',
5750
+ description:
5751
+ 'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
4851
5752
  example: 'Expenses:Unknown'
4852
5753
  },
4853
5754
  defaultIncomeAccount: {
4854
5755
  type: 'string',
4855
- description: 'Default income account for the second posting',
5756
+ description:
5757
+ 'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
4856
5758
  example: 'Income:Unknown'
4857
5759
  },
4858
5760
  filterPending: {
4859
5761
  type: 'boolean',
4860
5762
  description: 'Filter pending transactions',
4861
5763
  default: true
5764
+ },
5765
+ externalAccountId: {
5766
+ type: 'string',
5767
+ description:
5768
+ 'External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.',
5769
+ example: 'acc_gocardless_001'
4862
5770
  }
4863
5771
  },
4864
- required: [
4865
- 'sourceAccount',
4866
- 'defaultCurrency',
4867
- 'defaultExpenseAccount',
4868
- 'defaultIncomeAccount'
4869
- ]
5772
+ required: ['sourceAccount', 'defaultCurrency']
4870
5773
  } as const;
4871
5774
 
4872
5775
  export const $ProviderSyncDto = {
@@ -4951,15 +5854,39 @@ export const $ProviderSyncResponseDto = {
4951
5854
  }
4952
5855
  }
4953
5856
  },
4954
- required: ['imported', 'skipped', 'pendingReview', 'failed']
5857
+ required: ['imported', 'skipped', 'pendingReview', 'failed']
5858
+ } as const;
5859
+
5860
+ export const $SupportedProvidersResponseDto = {
5861
+ type: 'object',
5862
+ properties: {
5863
+ providers: {
5864
+ description: 'List of supported provider names',
5865
+ example: [
5866
+ 'plaid',
5867
+ 'teller',
5868
+ 'truelayer',
5869
+ 'gocardless',
5870
+ 'simplefin',
5871
+ 'yodlee',
5872
+ 'beancount-direct',
5873
+ 'parsed-bill'
5874
+ ],
5875
+ type: 'array',
5876
+ items: {
5877
+ type: 'string'
5878
+ }
5879
+ }
5880
+ },
5881
+ required: ['providers']
4955
5882
  } as const;
4956
5883
 
4957
- export const $SupportedProvidersResponseDto = {
5884
+ export const $CreateExternalAccountLinkDto = {
4958
5885
  type: 'object',
4959
5886
  properties: {
4960
- providers: {
4961
- description: 'List of supported provider names',
4962
- example: [
5887
+ provider: {
5888
+ type: 'string',
5889
+ enum: [
4963
5890
  'plaid',
4964
5891
  'teller',
4965
5892
  'truelayer',
@@ -4969,13 +5896,77 @@ export const $SupportedProvidersResponseDto = {
4969
5896
  'beancount-direct',
4970
5897
  'parsed-bill'
4971
5898
  ],
5899
+ example: 'plaid',
5900
+ description: 'Open Banking provider (whitelist)'
5901
+ },
5902
+ externalAccountId: {
5903
+ type: 'string',
5904
+ example: 'acc-plaid-001',
5905
+ description: 'External account ID from the provider'
5906
+ },
5907
+ beanAccountId: {
5908
+ type: 'string',
5909
+ example: '550e8400-e29b-41d4-a716-446655440000',
5910
+ description: 'Target BeanAccount ID (must belong to the JWT user)'
5911
+ }
5912
+ },
5913
+ required: ['provider', 'externalAccountId', 'beanAccountId']
5914
+ } as const;
5915
+
5916
+ export const $ExternalAccountLinkResponseDto = {
5917
+ type: 'object',
5918
+ properties: {
5919
+ id: {
5920
+ type: 'string'
5921
+ },
5922
+ provider: {
5923
+ type: 'string'
5924
+ },
5925
+ externalAccountId: {
5926
+ type: 'string'
5927
+ },
5928
+ beanAccountId: {
5929
+ type: 'string'
5930
+ },
5931
+ isActive: {
5932
+ type: 'boolean'
5933
+ },
5934
+ createdAt: {
5935
+ type: 'string'
5936
+ },
5937
+ updatedAt: {
5938
+ type: 'string'
5939
+ }
5940
+ },
5941
+ required: [
5942
+ 'id',
5943
+ 'provider',
5944
+ 'externalAccountId',
5945
+ 'beanAccountId',
5946
+ 'isActive',
5947
+ 'createdAt',
5948
+ 'updatedAt'
5949
+ ]
5950
+ } as const;
5951
+
5952
+ export const $ExternalAccountLinkListResponseDto = {
5953
+ type: 'object',
5954
+ properties: {
5955
+ items: {
4972
5956
  type: 'array',
4973
5957
  items: {
4974
- type: 'string'
5958
+ $ref: '#/components/schemas/ExternalAccountLinkResponseDto'
4975
5959
  }
5960
+ },
5961
+ total: {
5962
+ type: 'number'
5963
+ },
5964
+ provider: {
5965
+ type: 'string',
5966
+ description: 'Filter by provider (query param)'
4976
5967
  }
4977
5968
  },
4978
- required: ['providers']
5969
+ required: ['items', 'total']
4979
5970
  } as const;
4980
5971
 
4981
5972
  export const $ParserTelemetryReportDto = {
@@ -5012,6 +6003,18 @@ export const $ProcessNlpDto = {
5012
6003
  currency: 'CNY',
5013
6004
  payee: 'Starbucks'
5014
6005
  }
6006
+ },
6007
+ selectedRuleId: {
6008
+ type: 'string',
6009
+ description:
6010
+ 'confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.',
6011
+ example: 'rule_abc123'
6012
+ },
6013
+ selectedAccount: {
6014
+ type: 'string',
6015
+ description:
6016
+ '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.',
6017
+ example: 'Expenses:Food:Coffee'
5015
6018
  }
5016
6019
  },
5017
6020
  required: ['message']
@@ -5336,7 +6339,8 @@ export const $NlpAccountConfirmationDataDto = {
5336
6339
  },
5337
6340
  suggestedAccount: {
5338
6341
  type: 'string',
5339
- description: 'Suggested replacement account',
6342
+ description:
6343
+ 'Suggested replacement account (omitted when no clear candidate)',
5340
6344
  example: 'Expenses:Food:Drinks'
5341
6345
  },
5342
6346
  similarAccounts: {
@@ -5358,7 +6362,6 @@ export const $NlpAccountConfirmationDataDto = {
5358
6362
  },
5359
6363
  required: [
5360
6364
  'invalidAccount',
5361
- 'suggestedAccount',
5362
6365
  'similarAccounts',
5363
6366
  'errorMessage',
5364
6367
  'transactionContext'
@@ -5527,11 +6530,12 @@ export const $NlpSuggestedAccountDto = {
5527
6530
  account: {
5528
6531
  type: 'string',
5529
6532
  description: 'Suggested account path',
5530
- example: 'Assets:Bank:Checking'
6533
+ example: 'Assets:Checking'
5531
6534
  },
5532
6535
  confidence: {
5533
6536
  type: 'number',
5534
- description: 'Confidence score for this suggestion (0-1)',
6537
+ description:
6538
+ 'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
5535
6539
  example: 0.9
5536
6540
  }
5537
6541
  },
@@ -5567,23 +6571,31 @@ export const $NlpDefaultAccountsDto = {
5567
6571
  properties: {
5568
6572
  asset: {
5569
6573
  type: 'string',
5570
- description: 'Default asset account',
5571
- example: 'Assets:Bank:Checking'
6574
+ description:
6575
+ 'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
6576
+ example: 'Assets:Checking',
6577
+ nullable: true
5572
6578
  },
5573
6579
  expense: {
5574
6580
  type: 'string',
5575
- description: 'Default expense account',
5576
- example: 'Expenses:Uncategorized'
6581
+ description:
6582
+ 'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
6583
+ example: 'Expenses:Food:Coffee',
6584
+ nullable: true
5577
6585
  },
5578
6586
  income: {
5579
6587
  type: 'string',
5580
- description: 'Default income account',
5581
- example: 'Income:Uncategorized'
6588
+ description:
6589
+ 'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
6590
+ example: 'Income:Salary',
6591
+ nullable: true
5582
6592
  },
5583
6593
  liability: {
5584
6594
  type: 'string',
5585
- description: 'Default liability account',
5586
- example: 'Liabilities:CreditCard'
6595
+ description:
6596
+ 'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
6597
+ example: 'Liabilities:CreditCard',
6598
+ nullable: true
5587
6599
  }
5588
6600
  },
5589
6601
  required: ['asset', 'expense', 'income', 'liability']
@@ -5608,7 +6620,8 @@ export const $NlpResponseDto = {
5608
6620
  'confirm_rule',
5609
6621
  'confirm_account',
5610
6622
  'confirm_payee',
5611
- 'cancel'
6623
+ 'cancel',
6624
+ 'aborted'
5612
6625
  ]
5613
6626
  },
5614
6627
  intent: {
@@ -5770,7 +6783,7 @@ export const $NlpResponseDto = {
5770
6783
  },
5771
6784
  suggestedAccounts: {
5772
6785
  description:
5773
- 'Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.',
6786
+ 'Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.',
5774
6787
  allOf: [
5775
6788
  {
5776
6789
  $ref: '#/components/schemas/NlpSuggestedAccountsDto'
@@ -5779,7 +6792,7 @@ export const $NlpResponseDto = {
5779
6792
  },
5780
6793
  defaultAccounts: {
5781
6794
  description:
5782
- 'Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.',
6795
+ 'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
5783
6796
  allOf: [
5784
6797
  {
5785
6798
  $ref: '#/components/schemas/NlpDefaultAccountsDto'
@@ -5787,24 +6800,285 @@ export const $NlpResponseDto = {
5787
6800
  ]
5788
6801
  }
5789
6802
  },
5790
- required: ['status', 'action']
6803
+ required: ['status', 'action']
6804
+ } as const;
6805
+
6806
+ export const $PlatformListItemDto = {
6807
+ type: 'object',
6808
+ properties: {
6809
+ id: {
6810
+ type: 'string',
6811
+ description: 'Global platform ID'
6812
+ },
6813
+ name: {
6814
+ type: 'string',
6815
+ description: 'Platform name'
6816
+ },
6817
+ url: {
6818
+ type: 'string',
6819
+ description: 'Platform URL'
6820
+ },
6821
+ type: {
6822
+ type: 'string',
6823
+ description: 'Platform type',
6824
+ enum: [
6825
+ 'BANK',
6826
+ 'BROKERAGE',
6827
+ 'CRYPTO_EXCHANGE',
6828
+ 'PAYMENT',
6829
+ 'INVESTMENT',
6830
+ 'INSURANCE',
6831
+ 'OTHER'
6832
+ ]
6833
+ },
6834
+ canonical: {
6835
+ type: 'string',
6836
+ description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
6837
+ },
6838
+ suggestedSegment: {
6839
+ type: 'string',
6840
+ description:
6841
+ 'Suggested path segment — PascalCase of canonical, hyphens removed (e.g. "ApplePay")'
6842
+ },
6843
+ logoUrl: {
6844
+ type: 'string',
6845
+ description: 'Logo URL',
6846
+ nullable: true
6847
+ },
6848
+ countryCode: {
6849
+ type: 'string',
6850
+ description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
6851
+ example: 'CN',
6852
+ nullable: true
6853
+ },
6854
+ category: {
6855
+ type: 'string',
6856
+ description:
6857
+ 'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
6858
+ nullable: true,
6859
+ example: 'DigitalWallet'
6860
+ },
6861
+ isBound: {
6862
+ type: 'boolean',
6863
+ description: 'Whether user has accounts using this platform'
6864
+ }
6865
+ },
6866
+ required: [
6867
+ 'id',
6868
+ 'name',
6869
+ 'url',
6870
+ 'type',
6871
+ 'canonical',
6872
+ 'suggestedSegment',
6873
+ 'logoUrl',
6874
+ 'countryCode',
6875
+ 'category',
6876
+ 'isBound'
6877
+ ]
6878
+ } as const;
6879
+
6880
+ export const $PlatformMatchResultDto = {
6881
+ type: 'object',
6882
+ properties: {
6883
+ id: {
6884
+ type: 'string',
6885
+ description: 'Global platform ID'
6886
+ },
6887
+ name: {
6888
+ type: 'string',
6889
+ description: 'Platform name (e.g., "ICBC")'
6890
+ },
6891
+ canonical: {
6892
+ type: 'string',
6893
+ description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
6894
+ },
6895
+ type: {
6896
+ type: 'string',
6897
+ description: 'Platform type',
6898
+ enum: [
6899
+ 'BANK',
6900
+ 'BROKERAGE',
6901
+ 'CRYPTO_EXCHANGE',
6902
+ 'PAYMENT',
6903
+ 'INVESTMENT',
6904
+ 'INSURANCE',
6905
+ 'OTHER'
6906
+ ]
6907
+ },
6908
+ suggestedSegment: {
6909
+ type: 'string',
6910
+ description:
6911
+ 'Suggested path segment — PascalCase of canonical, hyphens removed (e.g. "ApplePay")'
6912
+ },
6913
+ logoUrl: {
6914
+ type: 'string',
6915
+ description: 'Logo URL',
6916
+ nullable: true
6917
+ },
6918
+ countryCode: {
6919
+ type: 'string',
6920
+ description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
6921
+ example: 'CN',
6922
+ nullable: true
6923
+ },
6924
+ category: {
6925
+ type: 'string',
6926
+ description:
6927
+ 'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
6928
+ nullable: true,
6929
+ example: 'DigitalWallet'
6930
+ },
6931
+ matchType: {
6932
+ type: 'string',
6933
+ description: "How this row matched: 'exact' > 'prefix' > 'substring'",
6934
+ enum: ['exact', 'prefix', 'substring']
6935
+ }
6936
+ },
6937
+ required: [
6938
+ 'id',
6939
+ 'name',
6940
+ 'canonical',
6941
+ 'type',
6942
+ 'suggestedSegment',
6943
+ 'logoUrl',
6944
+ 'countryCode',
6945
+ 'category',
6946
+ 'matchType'
6947
+ ]
6948
+ } as const;
6949
+
6950
+ export const $PlatformMatchResponseDto = {
6951
+ type: 'object',
6952
+ properties: {
6953
+ platforms: {
6954
+ description: 'Ranked matches, best tier first (at most 10 rows)',
6955
+ type: 'array',
6956
+ items: {
6957
+ $ref: '#/components/schemas/PlatformMatchResultDto'
6958
+ }
6959
+ },
6960
+ matchType: {
6961
+ type: 'string',
6962
+ description:
6963
+ "Overall match quality — top row's tier, or 'none' when no hits",
6964
+ enum: ['none', 'exact', 'prefix', 'substring']
6965
+ },
6966
+ total: {
6967
+ type: 'number',
6968
+ description: 'Total matches before LIMIT (truncation transparency)'
6969
+ },
6970
+ hasMore: {
6971
+ type: 'boolean',
6972
+ description: 'true when total > platforms.length (more matches exist)'
6973
+ }
6974
+ },
6975
+ required: ['platforms', 'matchType', 'total', 'hasMore']
6976
+ } as const;
6977
+
6978
+ export const $CreatePlatformDto = {
6979
+ type: 'object',
6980
+ properties: {
6981
+ name: {
6982
+ type: 'string',
6983
+ description: 'Platform name',
6984
+ example: 'Binance'
6985
+ },
6986
+ canonical: {
6987
+ type: 'string',
6988
+ description: 'Platform canonical identifier (lowercase, kebab-case)',
6989
+ example: 'binance'
6990
+ },
6991
+ aliases: {
6992
+ description: 'Platform aliases (multi-language names for lookup)',
6993
+ example: ['Binance', 'Binance Exchange', 'BNB'],
6994
+ type: 'array',
6995
+ items: {
6996
+ type: 'string'
6997
+ }
6998
+ },
6999
+ url: {
7000
+ type: 'string',
7001
+ description: 'Platform URL',
7002
+ example: 'https://www.binance.com'
7003
+ },
7004
+ type: {
7005
+ type: 'string',
7006
+ description: 'Platform type',
7007
+ enum: [
7008
+ 'BANK',
7009
+ 'BROKERAGE',
7010
+ 'CRYPTO_EXCHANGE',
7011
+ 'PAYMENT',
7012
+ 'INVESTMENT',
7013
+ 'INSURANCE',
7014
+ 'OTHER'
7015
+ ],
7016
+ example: 'CRYPTO_EXCHANGE'
7017
+ },
7018
+ logoUrl: {
7019
+ type: 'string',
7020
+ description: 'Platform logo URL',
7021
+ example: 'https://example.com/logos/binance.png'
7022
+ },
7023
+ isActive: {
7024
+ type: 'boolean',
7025
+ description: 'Whether the platform is active',
7026
+ default: true
7027
+ }
7028
+ },
7029
+ required: ['name', 'canonical', 'aliases', 'url', 'type']
5791
7030
  } as const;
5792
7031
 
5793
- export const $BalanceByCurrencyDto = {
7032
+ export const $UpdatePlatformDto = {
5794
7033
  type: 'object',
5795
7034
  properties: {
5796
- currency: {
7035
+ name: {
5797
7036
  type: 'string',
5798
- description: 'ISO 4217 currency code',
5799
- example: 'CNY'
7037
+ description: 'Platform name',
7038
+ example: 'Binance'
5800
7039
  },
5801
- balance: {
7040
+ canonical: {
5802
7041
  type: 'string',
5803
- description: 'Balance amount',
5804
- example: '50000.00'
7042
+ description: 'Platform canonical identifier (lowercase, kebab-case)',
7043
+ example: 'binance'
7044
+ },
7045
+ aliases: {
7046
+ description: 'Platform aliases (multi-language names for lookup)',
7047
+ example: ['Binance', 'Binance Exchange', 'BNB'],
7048
+ type: 'array',
7049
+ items: {
7050
+ type: 'string'
7051
+ }
7052
+ },
7053
+ url: {
7054
+ type: 'string',
7055
+ description: 'Platform URL',
7056
+ example: 'https://www.binance.com'
7057
+ },
7058
+ type: {
7059
+ type: 'string',
7060
+ description: 'Platform type',
7061
+ enum: [
7062
+ 'BANK',
7063
+ 'BROKERAGE',
7064
+ 'CRYPTO_EXCHANGE',
7065
+ 'PAYMENT',
7066
+ 'INVESTMENT',
7067
+ 'INSURANCE',
7068
+ 'OTHER'
7069
+ ],
7070
+ example: 'CRYPTO_EXCHANGE'
7071
+ },
7072
+ logoUrl: {
7073
+ type: 'string',
7074
+ description: 'Platform logo URL',
7075
+ example: 'https://example.com/logos/binance.png'
7076
+ },
7077
+ isActive: {
7078
+ type: 'boolean',
7079
+ description: 'Whether the platform is active'
5805
7080
  }
5806
- },
5807
- required: ['currency', 'balance']
7081
+ }
5808
7082
  } as const;
5809
7083
 
5810
7084
  export const $NetWorthByCurrencyDto = {
@@ -5876,28 +7150,6 @@ export const $ConvertedNetWorthDto = {
5876
7150
  ]
5877
7151
  } as const;
5878
7152
 
5879
- export const $ExchangeRateWarningDto = {
5880
- type: 'object',
5881
- properties: {
5882
- type: {
5883
- type: 'string',
5884
- description: 'Warning type',
5885
- example: 'MISSING_EXCHANGE_RATE'
5886
- },
5887
- currency: {
5888
- type: 'string',
5889
- description: 'Currency without exchange rate',
5890
- example: 'EUR'
5891
- },
5892
- totalAmount: {
5893
- type: 'string',
5894
- description: 'Total amount affected',
5895
- example: '1000.00'
5896
- }
5897
- },
5898
- required: ['type', 'currency', 'totalAmount']
5899
- } as const;
5900
-
5901
7153
  export const $NetWorthResponseDto = {
5902
7154
  type: 'object',
5903
7155
  properties: {
@@ -5983,7 +7235,7 @@ export const $AccountItemDto = {
5983
7235
  name: {
5984
7236
  type: 'string',
5985
7237
  description: 'Full account name',
5986
- example: 'Assets:Bank:CMB:Savings'
7238
+ example: 'Assets:CN:CMB:Savings'
5987
7239
  },
5988
7240
  displayName: {
5989
7241
  type: 'string',
@@ -5999,6 +7251,12 @@ export const $AccountItemDto = {
5999
7251
  type: 'string',
6000
7252
  description: 'Currency code',
6001
7253
  example: 'CNY'
7254
+ },
7255
+ convertedBalance: {
7256
+ type: 'string',
7257
+ description:
7258
+ 'FX-converted balance in base currency; omitted when not convertible',
7259
+ example: '50000.00'
6002
7260
  }
6003
7261
  },
6004
7262
  required: ['id', 'name', 'displayName', 'balance', 'currency']
@@ -6025,11 +7283,66 @@ export const $PlatformGroupDto = {
6025
7283
  },
6026
7284
  totalBalance: {
6027
7285
  type: 'string',
6028
- description: 'Total balance across all accounts in platform',
7286
+ description: 'FX-converted total balance in base currency',
7287
+ example: '100000.00'
7288
+ },
7289
+ balanceByCurrency: {
7290
+ description: 'Raw (unconverted) balances grouped by currency',
7291
+ type: 'array',
7292
+ items: {
7293
+ $ref: '#/components/schemas/BalanceByCurrencyDto'
7294
+ }
7295
+ },
7296
+ convertedBalance: {
7297
+ type: 'string',
7298
+ description:
7299
+ 'Converted balance in base currency (omitted when no currency is convertible)',
6029
7300
  example: '100000.00'
7301
+ },
7302
+ sharePct: {
7303
+ type: 'number',
7304
+ description:
7305
+ 'Share of the grand converted total (0-100); 0 when grand total is 0',
7306
+ example: 42.5
7307
+ }
7308
+ },
7309
+ required: [
7310
+ 'platformId',
7311
+ 'platformName',
7312
+ 'accounts',
7313
+ 'totalBalance',
7314
+ 'balanceByCurrency',
7315
+ 'sharePct'
7316
+ ]
7317
+ } as const;
7318
+
7319
+ export const $AccountExchangeRateWarningDto = {
7320
+ type: 'object',
7321
+ properties: {
7322
+ type: {
7323
+ type: 'string',
7324
+ description: 'Warning type',
7325
+ example: 'MISSING_EXCHANGE_RATE'
7326
+ },
7327
+ currency: {
7328
+ type: 'string',
7329
+ description: 'Currency without exchange rate',
7330
+ example: 'USD'
7331
+ },
7332
+ accounts: {
7333
+ description: 'Affected account paths',
7334
+ type: 'array',
7335
+ items: {
7336
+ type: 'string'
7337
+ }
7338
+ },
7339
+ totalAmount: {
7340
+ type: 'string',
7341
+ description: 'Total amount in this currency',
7342
+ example: '5000.00'
6030
7343
  }
6031
7344
  },
6032
- required: ['platformId', 'platformName', 'accounts', 'totalBalance']
7345
+ required: ['type', 'currency', 'accounts', 'totalAmount']
6033
7346
  } as const;
6034
7347
 
6035
7348
  export const $AccountsSummaryDto = {
@@ -6042,9 +7355,21 @@ export const $AccountsSummaryDto = {
6042
7355
  totalPlatforms: {
6043
7356
  type: 'number',
6044
7357
  description: 'Total number of platforms'
7358
+ },
7359
+ baseCurrency: {
7360
+ type: 'string',
7361
+ description: 'Base currency for conversion',
7362
+ example: 'CNY'
7363
+ },
7364
+ warnings: {
7365
+ description: 'Per-account exchange rate warnings',
7366
+ type: 'array',
7367
+ items: {
7368
+ $ref: '#/components/schemas/AccountExchangeRateWarningDto'
7369
+ }
6045
7370
  }
6046
7371
  },
6047
- required: ['totalAccounts', 'totalPlatforms']
7372
+ required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
6048
7373
  } as const;
6049
7374
 
6050
7375
  export const $AccountsResponseDto = {
@@ -6079,7 +7404,7 @@ export const $AccountItemWithAssetClassDto = {
6079
7404
  name: {
6080
7405
  type: 'string',
6081
7406
  description: 'Full account name',
6082
- example: 'Assets:Bank:CMB:Savings'
7407
+ example: 'Assets:CN:CMB:Savings'
6083
7408
  },
6084
7409
  displayName: {
6085
7410
  type: 'string',
@@ -6096,6 +7421,12 @@ export const $AccountItemWithAssetClassDto = {
6096
7421
  description: 'Currency code',
6097
7422
  example: 'CNY'
6098
7423
  },
7424
+ convertedBalance: {
7425
+ type: 'string',
7426
+ description:
7427
+ 'FX-converted balance in base currency; omitted when not convertible',
7428
+ example: '50000.00'
7429
+ },
6099
7430
  assetClass: {
6100
7431
  type: 'string',
6101
7432
  description: 'Asset class',
@@ -6175,35 +7506,6 @@ export const $AssetClassGroupDto = {
6175
7506
  required: ['assetClass', 'accounts', 'balanceByCurrency']
6176
7507
  } as const;
6177
7508
 
6178
- export const $AccountExchangeRateWarningDto = {
6179
- type: 'object',
6180
- properties: {
6181
- type: {
6182
- type: 'string',
6183
- description: 'Warning type',
6184
- example: 'MISSING_EXCHANGE_RATE'
6185
- },
6186
- currency: {
6187
- type: 'string',
6188
- description: 'Currency without exchange rate',
6189
- example: 'USD'
6190
- },
6191
- accounts: {
6192
- description: 'Affected account paths',
6193
- type: 'array',
6194
- items: {
6195
- type: 'string'
6196
- }
6197
- },
6198
- totalAmount: {
6199
- type: 'string',
6200
- description: 'Total amount in this currency',
6201
- example: '5000.00'
6202
- }
6203
- },
6204
- required: ['type', 'currency', 'accounts', 'totalAmount']
6205
- } as const;
6206
-
6207
7509
  export const $AssetClassSummaryDto = {
6208
7510
  type: 'object',
6209
7511
  properties: {
@@ -6277,7 +7579,7 @@ export const $HoldingAssetClassAccountSliceDto = {
6277
7579
  accountPath: {
6278
7580
  type: 'string',
6279
7581
  description: 'Full account path',
6280
- example: 'Assets:US:Investments:Brokerage'
7582
+ example: 'Assets:US:Fidelity:Brokerage'
6281
7583
  },
6282
7584
  accountCurrency: {
6283
7585
  type: 'string',
@@ -6449,38 +7751,133 @@ export const $CashFlowResponseDto = {
6449
7751
  description: 'Base currency code',
6450
7752
  example: 'CNY'
6451
7753
  },
6452
- byCurrency: {
6453
- description: 'Cash flow grouped by original currency',
6454
- allOf: [
6455
- {
6456
- $ref: '#/components/schemas/CashFlowByCurrencyDto'
6457
- }
6458
- ]
7754
+ byCurrency: {
7755
+ description: 'Cash flow grouped by original currency',
7756
+ allOf: [
7757
+ {
7758
+ $ref: '#/components/schemas/CashFlowByCurrencyDto'
7759
+ }
7760
+ ]
7761
+ },
7762
+ converted: {
7763
+ description: 'Converted values in base currency',
7764
+ allOf: [
7765
+ {
7766
+ $ref: '#/components/schemas/ConvertedCashFlowDto'
7767
+ }
7768
+ ]
7769
+ },
7770
+ warnings: {
7771
+ description: 'Exchange rate warnings',
7772
+ type: 'array',
7773
+ items: {
7774
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
7775
+ }
7776
+ }
7777
+ },
7778
+ required: [
7779
+ 'period',
7780
+ 'income',
7781
+ 'expense',
7782
+ 'netSavings',
7783
+ 'savingsRate',
7784
+ 'currency'
7785
+ ]
7786
+ } as const;
7787
+
7788
+ export const $CategoryGroupDto = {
7789
+ type: 'object',
7790
+ properties: {
7791
+ category: {
7792
+ type: 'string',
7793
+ description:
7794
+ 'Functional category (account-path Group segment); regional and universal account paths merge under it',
7795
+ example: 'Food'
7796
+ },
7797
+ totalExpense: {
7798
+ type: 'string',
7799
+ description:
7800
+ 'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
7801
+ example: '1200.00'
7802
+ },
7803
+ sharePct: {
7804
+ type: 'number',
7805
+ description: 'Share of grand total (0-100); 0 when grand total is 0',
7806
+ example: 42.5
7807
+ },
7808
+ balanceByCurrency: {
7809
+ description: 'Raw (unconverted) expense per currency',
7810
+ type: 'array',
7811
+ items: {
7812
+ $ref: '#/components/schemas/BalanceByCurrencyDto'
7813
+ }
7814
+ },
7815
+ convertedBalance: {
7816
+ type: 'string',
7817
+ description:
7818
+ 'Converted total in base currency (omitted when FX missing for all currencies in this category)',
7819
+ example: '1200.00'
7820
+ }
7821
+ },
7822
+ required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
7823
+ } as const;
7824
+
7825
+ export const $ExpensesByCategorySummaryDto = {
7826
+ type: 'object',
7827
+ properties: {
7828
+ totalExpense: {
7829
+ type: 'string',
7830
+ description:
7831
+ 'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
7832
+ example: '5000.00'
7833
+ },
7834
+ categoryCount: {
7835
+ type: 'number',
7836
+ description: 'Number of categories',
7837
+ example: 8
7838
+ }
7839
+ },
7840
+ required: ['totalExpense', 'categoryCount']
7841
+ } as const;
7842
+
7843
+ export const $ExpensesByCategoryResponseDto = {
7844
+ type: 'object',
7845
+ properties: {
7846
+ period: {
7847
+ type: 'string',
7848
+ description: 'Period requested',
7849
+ example: '1m'
7850
+ },
7851
+ baseCurrency: {
7852
+ type: 'string',
7853
+ description: 'Base currency for converted values',
7854
+ example: 'CNY'
7855
+ },
7856
+ groups: {
7857
+ description:
7858
+ 'Expense groups by functional category, sorted by converted total desc',
7859
+ type: 'array',
7860
+ items: {
7861
+ $ref: '#/components/schemas/CategoryGroupDto'
7862
+ }
6459
7863
  },
6460
- converted: {
6461
- description: 'Converted values in base currency',
7864
+ summary: {
7865
+ description: 'Summary statistics',
6462
7866
  allOf: [
6463
7867
  {
6464
- $ref: '#/components/schemas/ConvertedCashFlowDto'
7868
+ $ref: '#/components/schemas/ExpensesByCategorySummaryDto'
6465
7869
  }
6466
7870
  ]
6467
7871
  },
6468
7872
  warnings: {
6469
- description: 'Exchange rate warnings',
7873
+ description: 'Exchange rate warnings (e.g. missing rate for a currency)',
6470
7874
  type: 'array',
6471
7875
  items: {
6472
7876
  $ref: '#/components/schemas/ExchangeRateWarningDto'
6473
7877
  }
6474
7878
  }
6475
7879
  },
6476
- required: [
6477
- 'period',
6478
- 'income',
6479
- 'expense',
6480
- 'netSavings',
6481
- 'savingsRate',
6482
- 'currency'
6483
- ]
7880
+ required: ['period', 'baseCurrency', 'groups', 'summary']
6484
7881
  } as const;
6485
7882
 
6486
7883
  export const $MonetaryDto = {
@@ -6697,409 +8094,243 @@ export const $HoldingPnlRowDto = {
6697
8094
  },
6698
8095
  required: [
6699
8096
  'accountId',
6700
- 'accountPath',
6701
- 'symbol',
6702
- 'chartToken',
6703
- 'assetClass',
6704
- 'units'
6705
- ]
6706
- } as const;
6707
-
6708
- export const $HoldingPnlWarningDto = {
6709
- type: 'object',
6710
- properties: {
6711
- type: {
6712
- type: 'string',
6713
- description: 'Warning type',
6714
- example: 'MISSING_COST_FX_RATE',
6715
- enum: [
6716
- 'MISSING_COST_FX_RATE',
6717
- 'MISSING_MARKET_FX_RATE',
6718
- 'MISSING_SALE_PRICE',
6719
- 'MISSING_REALIZED_FX_RATE',
6720
- 'OVERSOLD_LOTS',
6721
- 'NO_PRICE',
6722
- 'MIXED_COST_CURRENCY'
6723
- ]
6724
- },
6725
- symbol: {
6726
- type: 'object',
6727
- nullable: true
6728
- },
6729
- accountId: {
6730
- type: 'object',
6731
- nullable: true
6732
- },
6733
- currency: {
6734
- type: 'object',
6735
- nullable: true
6736
- }
6737
- },
6738
- required: ['type']
6739
- } as const;
6740
-
6741
- export const $HoldingPnlResponseDto = {
6742
- type: 'object',
6743
- properties: {
6744
- asOfDate: {
6745
- type: 'string',
6746
- example: '2026-07-08'
6747
- },
6748
- baseCurrency: {
6749
- type: 'string',
6750
- example: 'CNY'
6751
- },
6752
- method: {
6753
- type: 'string',
6754
- description:
6755
- 'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
6756
- enum: ['average', 'FIFO'],
6757
- example: 'average'
6758
- },
6759
- rows: {
6760
- type: 'array',
6761
- items: {
6762
- $ref: '#/components/schemas/HoldingPnlRowDto'
6763
- }
6764
- },
6765
- warnings: {
6766
- type: 'array',
6767
- items: {
6768
- $ref: '#/components/schemas/HoldingPnlWarningDto'
6769
- }
6770
- }
6771
- },
6772
- required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
6773
- } as const;
6774
-
6775
- export const $CreateBeanPriceDto = {
6776
- type: 'object',
6777
- properties: {
6778
- currency: {
6779
- type: 'string',
6780
- description: 'Currency being priced (e.g., USD, AAPL, BTC)',
6781
- example: 'USD'
6782
- },
6783
- quoteCurrency: {
6784
- type: 'string',
6785
- description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
6786
- example: 'CNY'
6787
- },
6788
- amount: {
6789
- type: 'number',
6790
- description:
6791
- 'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
6792
- example: 175.5,
6793
- minimum: 0
6794
- },
6795
- date: {
6796
- type: 'string',
6797
- description: 'Price date (ISO 8601 format)',
6798
- example: '2024-11-05'
6799
- },
6800
- metadata: {
6801
- type: 'object',
6802
- description:
6803
- 'Metadata (validated by Zod schema, max field lengths enforced)',
6804
- example: {
6805
- source: 'MANUAL',
6806
- note: 'Bank valuation report',
6807
- confidence: 0.95
6808
- }
6809
- }
6810
- },
6811
- required: ['currency', 'quoteCurrency', 'amount', 'date']
6812
- } as const;
6813
-
6814
- export const $PriceResponseDto = {
6815
- type: 'object',
6816
- properties: {
6817
- id: {
6818
- type: 'string',
6819
- description: 'Unique identifier',
6820
- example: 'uuid-123-456'
6821
- },
6822
- userId: {
6823
- type: 'string',
6824
- description: 'User ID (owner of the price)',
6825
- example: 'user-123'
6826
- },
6827
- currency: {
6828
- type: 'string',
6829
- description: 'Currency being priced (e.g., USD, AAPL, BTC)',
6830
- example: 'BTC'
6831
- },
6832
- quoteCurrency: {
6833
- type: 'string',
6834
- description: 'Quote currency (pricing currency, e.g., USD, CNY)',
6835
- example: 'USD'
6836
- },
6837
- amount: {
6838
- type: 'number',
6839
- description:
6840
- 'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
6841
- example: 50000
6842
- },
6843
- date: {
6844
- type: 'string',
6845
- description:
6846
- 'Price date (ISO 8601 format). Represents the date this price was valid.',
6847
- example: '2024-01-01',
6848
- format: 'date'
6849
- },
6850
- meta: {
6851
- type: 'object',
6852
- description:
6853
- 'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
6854
- example: {
6855
- source: 'MANUAL',
6856
- note: 'User-defined price',
6857
- confidence: 1
6858
- }
6859
- },
6860
- createdAt: {
6861
- format: 'date-time',
6862
- type: 'string',
6863
- description: 'Creation timestamp',
6864
- example: '2024-11-03T10:00:00Z'
6865
- },
6866
- updatedAt: {
6867
- format: 'date-time',
6868
- type: 'string',
6869
- description: 'Last update timestamp',
6870
- example: '2024-11-03T10:00:00Z'
6871
- }
6872
- },
6873
- required: [
6874
- 'id',
6875
- 'userId',
6876
- 'currency',
6877
- 'quoteCurrency',
6878
- 'amount',
6879
- 'date',
6880
- 'meta',
6881
- 'createdAt',
6882
- 'updatedAt'
6883
- ]
6884
- } as const;
6885
-
6886
- export const $PriceListResponseDto = {
6887
- type: 'object',
6888
- properties: {
6889
- items: {
6890
- description: 'List of prices',
6891
- type: 'array',
6892
- items: {
6893
- $ref: '#/components/schemas/PriceResponseDto'
6894
- }
6895
- },
6896
- total: {
6897
- type: 'number',
6898
- description: 'Total number of prices',
6899
- example: 42
6900
- }
6901
- },
6902
- required: ['items', 'total']
6903
- } as const;
6904
-
6905
- export const $UpdateBeanPriceDto = {
6906
- type: 'object',
6907
- properties: {
6908
- currency: {
6909
- type: 'string',
6910
- description: 'Currency being priced'
6911
- },
6912
- quoteCurrency: {
6913
- type: 'string',
6914
- description: 'Quote currency (pricing currency)'
6915
- },
6916
- amount: {
6917
- type: 'number',
6918
- description: 'Price amount (MUST be >= 0 per Beancount spec)',
6919
- minimum: 0
6920
- },
6921
- date: {
6922
- type: 'string',
6923
- description: 'Price date (ISO 8601 format)'
6924
- },
6925
- metadata: {
6926
- type: 'object',
6927
- description: 'Metadata'
6928
- }
6929
- }
8097
+ 'accountPath',
8098
+ 'symbol',
8099
+ 'chartToken',
8100
+ 'assetClass',
8101
+ 'units'
8102
+ ]
6930
8103
  } as const;
6931
8104
 
6932
- export const $CurrencyBalanceDto = {
8105
+ export const $HoldingPnlWarningDto = {
6933
8106
  type: 'object',
6934
8107
  properties: {
6935
- currency: {
8108
+ type: {
6936
8109
  type: 'string',
6937
- description: 'ISO 4217 currency code',
6938
- example: 'CNY'
8110
+ description: 'Warning type',
8111
+ example: 'MISSING_COST_FX_RATE',
8112
+ enum: [
8113
+ 'MISSING_COST_FX_RATE',
8114
+ 'MISSING_MARKET_FX_RATE',
8115
+ 'MISSING_SALE_PRICE',
8116
+ 'MISSING_REALIZED_FX_RATE',
8117
+ 'OVERSOLD_LOTS',
8118
+ 'NO_PRICE',
8119
+ 'MIXED_COST_CURRENCY'
8120
+ ]
6939
8121
  },
6940
- balance: {
6941
- type: 'string',
6942
- description: 'Balance amount',
6943
- example: '500000.00'
8122
+ symbol: {
8123
+ type: 'object',
8124
+ nullable: true
8125
+ },
8126
+ accountId: {
8127
+ type: 'object',
8128
+ nullable: true
8129
+ },
8130
+ currency: {
8131
+ type: 'object',
8132
+ nullable: true
6944
8133
  }
6945
8134
  },
6946
- required: ['currency', 'balance']
8135
+ required: ['type']
6947
8136
  } as const;
6948
8137
 
6949
- export const $TimeSeriesPointDto = {
8138
+ export const $HoldingPnlResponseDto = {
6950
8139
  type: 'object',
6951
8140
  properties: {
6952
- date: {
8141
+ asOfDate: {
6953
8142
  type: 'string',
6954
- description: 'Date in YYYY-MM-DD format',
6955
- example: '2024-06-15'
8143
+ example: '2026-07-08'
6956
8144
  },
6957
- value: {
8145
+ baseCurrency: {
6958
8146
  type: 'string',
6959
- description: 'Value at this date (in base currency)',
6960
- example: '500000.00'
8147
+ example: 'CNY'
6961
8148
  },
6962
- change: {
6963
- type: 'object',
6964
- description: 'Change from previous point',
6965
- example: '5000.00'
8149
+ method: {
8150
+ type: 'string',
8151
+ description:
8152
+ 'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
8153
+ enum: ['average', 'FIFO'],
8154
+ example: 'average'
6966
8155
  },
6967
- byCurrency: {
6968
- description: 'Multi-currency breakdown for this point',
8156
+ rows: {
6969
8157
  type: 'array',
6970
8158
  items: {
6971
- $ref: '#/components/schemas/CurrencyBalanceDto'
8159
+ $ref: '#/components/schemas/HoldingPnlRowDto'
8160
+ }
8161
+ },
8162
+ warnings: {
8163
+ type: 'array',
8164
+ items: {
8165
+ $ref: '#/components/schemas/HoldingPnlWarningDto'
6972
8166
  }
6973
8167
  }
6974
8168
  },
6975
- required: ['date', 'value']
8169
+ required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
6976
8170
  } as const;
6977
8171
 
6978
- export const $TrendSummaryDto = {
8172
+ export const $AnonymousLoginDto = {
6979
8173
  type: 'object',
6980
8174
  properties: {
6981
- startValue: {
6982
- type: 'string',
6983
- description: 'Value at start of period',
6984
- example: '450000.00'
6985
- },
6986
- endValue: {
6987
- type: 'string',
6988
- description: 'Value at end of period',
6989
- example: '500000.00'
6990
- },
6991
- totalChange: {
6992
- type: 'string',
6993
- description: 'Total change over period',
6994
- example: '50000.00'
6995
- },
6996
- totalChangePercentage: {
8175
+ accessToken: {
6997
8176
  type: 'string',
6998
- description: 'Total change percentage',
6999
- example: '+11.11%'
8177
+ description: 'Access token for anonymous login'
7000
8178
  }
7001
8179
  },
7002
- required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
8180
+ required: ['accessToken']
7003
8181
  } as const;
7004
8182
 
7005
- export const $MultiCurrencyPointDto = {
8183
+ export const $AnonymousLoginResponseDto = {
7006
8184
  type: 'object',
7007
8185
  properties: {
7008
- date: {
8186
+ authToken: {
7009
8187
  type: 'string',
7010
- description: 'Date in YYYY-MM-DD format',
7011
- example: '2024-06-15'
7012
- },
7013
- byCurrency: {
7014
- description: 'Balances by currency',
7015
- type: 'array',
7016
- items: {
7017
- $ref: '#/components/schemas/CurrencyBalanceDto'
7018
- }
8188
+ description: 'JWT auth token',
8189
+ example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
7019
8190
  }
7020
8191
  },
7021
- required: ['date', 'byCurrency']
8192
+ required: ['authToken']
7022
8193
  } as const;
7023
8194
 
7024
- export const $PortfolioTrendsResponseDto = {
8195
+ export const $SymbolSearchResultDto = {
7025
8196
  type: 'object',
7026
8197
  properties: {
7027
- series: {
7028
- description: 'Time series data points',
7029
- type: 'array',
7030
- items: {
7031
- $ref: '#/components/schemas/TimeSeriesPointDto'
7032
- }
8198
+ symbol: {
8199
+ type: 'string',
8200
+ example: 'AAPL'
7033
8201
  },
7034
- summary: {
7035
- description: 'Period summary',
7036
- allOf: [
7037
- {
7038
- $ref: '#/components/schemas/TrendSummaryDto'
7039
- }
7040
- ]
8202
+ name: {
8203
+ type: 'object',
8204
+ example: 'Apple Inc.',
8205
+ nullable: true
7041
8206
  },
7042
- period: {
7043
- type: 'string',
7044
- description: 'Period requested',
7045
- example: '6m'
8207
+ exchange: {
8208
+ type: 'object',
8209
+ example: 'US',
8210
+ nullable: true
7046
8211
  },
7047
- granularity: {
7048
- type: 'string',
7049
- description: 'Data granularity',
7050
- example: 'month'
8212
+ assetType: {
8213
+ type: 'object',
8214
+ description: 'OpenBB asset_type (e.g. stock, etf)',
8215
+ example: 'stock',
8216
+ nullable: true
7051
8217
  },
7052
- currency: {
7053
- type: 'string',
7054
- description: 'Base currency for converted values',
7055
- example: 'CNY'
8218
+ assetClass: {
8219
+ type: 'object',
8220
+ description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
8221
+ example: 'EQUITY',
8222
+ nullable: true
7056
8223
  },
7057
- byCurrency: {
7058
- description:
7059
- 'Multi-currency time series (each point has currency breakdown)',
7060
- type: 'array',
7061
- items: {
7062
- $ref: '#/components/schemas/MultiCurrencyPointDto'
7063
- }
8224
+ assetSubClass: {
8225
+ type: 'object',
8226
+ description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
8227
+ example: 'STOCK',
8228
+ nullable: true
7064
8229
  },
7065
- warnings: {
7066
- description: 'Exchange rate warnings',
7067
- type: 'array',
7068
- items: {
7069
- $ref: '#/components/schemas/ExchangeRateWarningDto'
7070
- }
8230
+ currency: {
8231
+ type: 'object',
8232
+ description: 'Trading currency (extra_data or inferred from exchange)',
8233
+ example: 'USD',
8234
+ nullable: true
7071
8235
  }
7072
8236
  },
7073
- required: ['series', 'summary', 'period', 'granularity', 'currency']
7074
- } as const;
7075
-
7076
- export const $GenerateSnapshotBody = {
7077
- type: 'object',
7078
- properties: {}
7079
- } as const;
7080
-
7081
- export const $GenerateSnapshotResponse = {
7082
- type: 'object',
7083
- properties: {}
7084
- } as const;
7085
-
7086
- export const $BackfillSnapshotsBody = {
7087
- type: 'object',
7088
- properties: {}
7089
- } as const;
7090
-
7091
- export const $BackfillSnapshotsResponse = {
7092
- type: 'object',
7093
- properties: {}
8237
+ required: ['symbol']
7094
8238
  } as const;
7095
8239
 
7096
- export const $AnonymousLoginDto = {
8240
+ export const $SymbolQuoteDto = {
7097
8241
  type: 'object',
7098
8242
  properties: {
7099
- accessToken: {
8243
+ symbol: {
7100
8244
  type: 'string',
7101
- description: 'Access token for anonymous login'
8245
+ example: 'AAPL'
8246
+ },
8247
+ name: {
8248
+ type: 'object',
8249
+ example: 'Apple Inc.',
8250
+ nullable: true
8251
+ },
8252
+ exchange: {
8253
+ type: 'object',
8254
+ example: 'US',
8255
+ nullable: true
8256
+ },
8257
+ assetType: {
8258
+ type: 'object',
8259
+ description: 'OpenBB asset_type',
8260
+ example: 'stock',
8261
+ nullable: true
8262
+ },
8263
+ assetClass: {
8264
+ type: 'object',
8265
+ description: 'IGN asset class',
8266
+ example: 'EQUITY',
8267
+ nullable: true
8268
+ },
8269
+ assetSubClass: {
8270
+ type: 'object',
8271
+ description: 'IGN asset sub-class',
8272
+ example: 'STOCK',
8273
+ nullable: true
8274
+ },
8275
+ currency: {
8276
+ type: 'object',
8277
+ description: 'Trading currency (extra_data or inferred from exchange)',
8278
+ example: 'USD',
8279
+ nullable: true
8280
+ },
8281
+ price: {
8282
+ type: 'object',
8283
+ description: 'Latest price (Decimal string)',
8284
+ example: '189.84',
8285
+ nullable: true
8286
+ },
8287
+ priceDate: {
8288
+ type: 'object',
8289
+ description: 'Date the price was observed (ISO yyyy-MM-dd)',
8290
+ example: '2026-08-05',
8291
+ nullable: true
8292
+ },
8293
+ changePercent: {
8294
+ type: 'object',
8295
+ description:
8296
+ 'Change vs previous close, in percentage points (1.7 == 1.7%). openbb stores change_percent as a normalized decimal; this exposes percentage points for frontend convenience.',
8297
+ example: 1.7,
8298
+ nullable: true
8299
+ },
8300
+ prevClose: {
8301
+ type: 'object',
8302
+ description: 'Previous close (Decimal string)',
8303
+ nullable: true
8304
+ },
8305
+ open: {
8306
+ type: 'object',
8307
+ description: 'Day open (Decimal string)',
8308
+ nullable: true
8309
+ },
8310
+ high: {
8311
+ type: 'object',
8312
+ description: 'Day high (Decimal string)',
8313
+ nullable: true
8314
+ },
8315
+ low: {
8316
+ type: 'object',
8317
+ description: 'Day low (Decimal string)',
8318
+ nullable: true
8319
+ },
8320
+ volume: {
8321
+ type: 'object',
8322
+ description: 'Day volume (Decimal string)',
8323
+ nullable: true
8324
+ },
8325
+ yearHigh: {
8326
+ type: 'object',
8327
+ description: '52-week high (Decimal string)',
8328
+ nullable: true
8329
+ },
8330
+ yearLow: {
8331
+ type: 'object',
8332
+ description: '52-week low (Decimal string)',
8333
+ nullable: true
7102
8334
  }
7103
- },
7104
- required: ['accessToken']
8335
+ }
7105
8336
  } as const;