@firela/api-types 0.0.0-canary.32edff08 → 0.0.0-canary.3550df41

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,47 @@ 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
+ 'OTHER'
128
+ ],
129
+ nullable: true,
130
+ example: 'STOCK'
131
+ },
107
132
  status: {
108
133
  type: 'string',
109
134
  description: 'Account status',
@@ -145,26 +170,26 @@ export const $AccountResponseDto = {
145
170
  templatePath: {
146
171
  type: 'string',
147
172
  description: 'Template path reference',
148
- example: 'Assets:CN:Bank:ICBC:Checking'
173
+ example: 'Assets:CN:Checking'
149
174
  },
150
175
  isCustom: {
151
176
  type: 'boolean',
152
177
  description: 'Whether this is a custom (user-created) account',
153
178
  example: false
154
179
  },
155
- i18nKey: {
180
+ displayName: {
156
181
  type: 'string',
157
- description: 'i18n key for display name',
158
- example: 'account.assets.cn.bank.icbc.checking'
182
+ description: 'Localized display name (ADR-0114, read-time projection)',
183
+ example: 'Checking'
159
184
  },
160
185
  icon: {
161
186
  type: 'string',
162
187
  description: 'Icon identifier',
163
188
  example: 'bank-icbc'
164
189
  },
165
- openMeta: {
190
+ openDirectiveMeta: {
166
191
  type: 'object',
167
- description: 'Account metadata',
192
+ description: 'Open directive metadata (ADR-0115 Decision 9)',
168
193
  example: {
169
194
  branch: 'Downtown'
170
195
  }
@@ -192,7 +217,6 @@ export const $AccountResponseDto = {
192
217
  required: [
193
218
  'id',
194
219
  'path',
195
- 'displayName',
196
220
  'type',
197
221
  'status',
198
222
  'openDate',
@@ -225,11 +249,6 @@ export const $AccountListResponseDto = {
225
249
  export const $UpdateAccountDto = {
226
250
  type: 'object',
227
251
  properties: {
228
- displayName: {
229
- type: 'string',
230
- description: 'Display name to distinguish accounts at the same path',
231
- example: '招行工资卡'
232
- },
233
252
  currencies: {
234
253
  description: 'Allowed currencies (null = no restriction)',
235
254
  example: ['CNY', 'USD'],
@@ -251,19 +270,15 @@ export const $UpdateAccountDto = {
251
270
  'NONE'
252
271
  ]
253
272
  },
254
- i18nKey: {
255
- type: 'string',
256
- description: 'i18n key for display name',
257
- example: 'account.custom.mybank'
258
- },
259
273
  icon: {
260
274
  type: 'string',
261
275
  description: 'Icon identifier',
262
276
  example: 'bank-custom'
263
277
  },
264
- openMeta: {
278
+ openDirectiveMeta: {
265
279
  type: 'object',
266
- description: 'Additional metadata (merged with existing)',
280
+ description:
281
+ 'Open directive metadata (merged with existing; NOT an opening-balance amount)',
267
282
  example: {
268
283
  branch: 'Uptown'
269
284
  }
@@ -310,13 +325,47 @@ export const $ReopenAccountDto = {
310
325
  }
311
326
  } as const;
312
327
 
328
+ export const $CreateOpeningBalanceDto = {
329
+ type: 'object',
330
+ properties: {
331
+ amount: {
332
+ type: 'number',
333
+ description: 'Opening balance amount (non-negative)',
334
+ example: 1000
335
+ },
336
+ currency: {
337
+ type: 'string',
338
+ description: 'Currency code',
339
+ example: 'CNY'
340
+ },
341
+ date: {
342
+ format: 'date-time',
343
+ type: 'string',
344
+ description: 'Opening-balance date (defaults to now)',
345
+ example: '2024-01-01'
346
+ }
347
+ },
348
+ required: ['amount', 'currency']
349
+ } as const;
350
+
351
+ export const $OpeningBalanceResultDto = {
352
+ type: 'object',
353
+ properties: {
354
+ transactionId: {
355
+ type: 'string',
356
+ description: 'Created opening-balance transaction id.'
357
+ }
358
+ },
359
+ required: ['transactionId']
360
+ } as const;
361
+
313
362
  export const $AccountStandardResponseDto = {
314
363
  type: 'object',
315
364
  properties: {
316
365
  path: {
317
366
  type: 'string',
318
367
  description: 'Account path (hierarchical, colon-separated)',
319
- example: 'Assets:CN:Bank:ICBC:Checking'
368
+ example: 'Assets:CN:Checking'
320
369
  },
321
370
  type: {
322
371
  type: 'string',
@@ -324,11 +373,6 @@ export const $AccountStandardResponseDto = {
324
373
  enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
325
374
  example: 'Assets'
326
375
  },
327
- i18nKey: {
328
- type: 'string',
329
- description: 'i18n key for localized display name',
330
- example: 'account.assets.cn.bank.icbc.checking'
331
- },
332
376
  name: {
333
377
  type: 'string',
334
378
  description: 'Short localized display name',
@@ -353,7 +397,7 @@ export const $AccountStandardResponseDto = {
353
397
  example: 'bank-icbc'
354
398
  }
355
399
  },
356
- required: ['path', 'type', 'i18nKey', 'description', 'tags', 'icon']
400
+ required: ['path', 'type', 'description', 'tags', 'icon']
357
401
  } as const;
358
402
 
359
403
  export const $AccountStandardListResponseDto = {
@@ -383,18 +427,13 @@ export const $AccountStandardListResponseDto = {
383
427
  export const $TemplateMetadataDto = {
384
428
  type: 'object',
385
429
  properties: {
386
- extendable: {
387
- type: 'boolean',
388
- description: 'Whether this path can be extended',
389
- example: true
390
- },
391
430
  rootType: {
392
431
  type: 'string',
393
432
  description: 'Root account type',
394
433
  example: 'Assets'
395
434
  }
396
435
  },
397
- required: ['extendable', 'rootType']
436
+ required: ['rootType']
398
437
  } as const;
399
438
 
400
439
  export const $TemplateMetadataResponseDto = {
@@ -466,6 +505,66 @@ export const $RegionsMetadataResponseDto = {
466
505
  required: ['regions']
467
506
  } as const;
468
507
 
508
+ export const $CostSpecDto = {
509
+ type: 'object',
510
+ properties: {
511
+ mode: {
512
+ type: 'string',
513
+ enum: ['per-unit', 'total', 'date', 'label', 'auto'],
514
+ description: 'Cost specification mode (mirrors engine CostSpec)'
515
+ },
516
+ numberPerUnit: {
517
+ type: 'string',
518
+ description: 'Per-unit cost (required when mode is "per-unit")',
519
+ example: '240'
520
+ },
521
+ totalNumber: {
522
+ type: 'string',
523
+ description: 'Total cost for all units (required when mode is "total")',
524
+ example: '12000'
525
+ },
526
+ currency: {
527
+ type: 'string',
528
+ description: 'Cost currency (required in all modes)',
529
+ example: 'USD'
530
+ },
531
+ date: {
532
+ type: 'string',
533
+ description:
534
+ 'Lot acquisition date, ISO 8601 (required when mode is "date")',
535
+ example: '2024-01-15'
536
+ },
537
+ label: {
538
+ type: 'string',
539
+ description:
540
+ 'Lot label (required when mode is "label"; optional tag in buy modes)'
541
+ },
542
+ merge: {
543
+ type: 'boolean',
544
+ description: 'Merge lots for AVERAGE booking (mode: auto)'
545
+ }
546
+ },
547
+ required: ['mode', 'currency']
548
+ } as const;
549
+
550
+ export const $AmountDto = {
551
+ type: 'object',
552
+ properties: {
553
+ number: {
554
+ type: 'string',
555
+ description:
556
+ 'Amount as decimal string (max 15 integer + 15 decimal digits)',
557
+ example: '170.50'
558
+ },
559
+ currency: {
560
+ type: 'string',
561
+ description: 'Currency/commodity code',
562
+ example: 'USD'
563
+ }
564
+ },
565
+ required: ['number', 'currency']
566
+ } as const;
567
+
469
568
  export const $CreatePostingDto = {
470
569
  type: 'object',
471
570
  properties: {
@@ -473,7 +572,7 @@ export const $CreatePostingDto = {
473
572
  type: 'string',
474
573
  description:
475
574
  'Account name in Beancount format (must start with uppercase, colon-separated)',
476
- example: 'Assets:Bank:Checking'
575
+ example: 'Assets:Checking'
477
576
  },
478
577
  units: {
479
578
  type: 'string',
@@ -495,6 +594,33 @@ export const $CreatePostingDto = {
495
594
  example: {
496
595
  'tax-lot': 'Q1-2024'
497
596
  }
597
+ },
598
+ cost: {
599
+ description:
600
+ 'Cost basis (Beancount `{...}`). Maps to engine costSpec. Required for commodity holdings so they carry a monetary weight that can balance.',
601
+ example: {
602
+ mode: 'per-unit',
603
+ numberPerUnit: '240',
604
+ currency: 'USD'
605
+ },
606
+ allOf: [
607
+ {
608
+ $ref: '#/components/schemas/CostSpecDto'
609
+ }
610
+ ]
611
+ },
612
+ price: {
613
+ description:
614
+ 'Price annotation (Beancount `@...`). Maps to engine price. Used for valuation; cost takes priority for balance weight.',
615
+ example: {
616
+ number: '170',
617
+ currency: 'USD'
618
+ },
619
+ allOf: [
620
+ {
621
+ $ref: '#/components/schemas/AmountDto'
622
+ }
623
+ ]
498
624
  }
499
625
  },
500
626
  required: ['account']
@@ -573,13 +699,39 @@ export const $CreateTransactionDto = {
573
699
  required: ['date', 'narration', 'postings']
574
700
  } as const;
575
701
 
702
+ export const $CostDetailDto = {
703
+ type: 'object',
704
+ properties: {
705
+ number: {
706
+ type: 'string',
707
+ description: 'Per-unit cost basis (mirrors engine Cost.number)',
708
+ example: '240'
709
+ },
710
+ currency: {
711
+ type: 'string',
712
+ description: 'Cost currency',
713
+ example: 'USD'
714
+ },
715
+ date: {
716
+ type: 'string',
717
+ description: 'Lot acquisition date (ISO yyyy-mm-dd)',
718
+ example: '2024-01-15'
719
+ },
720
+ label: {
721
+ type: 'string',
722
+ description: 'Lot label',
723
+ example: 'lot-2024-01'
724
+ }
725
+ }
726
+ } as const;
727
+
576
728
  export const $PostingResponseDto = {
577
729
  type: 'object',
578
730
  properties: {
579
731
  account: {
580
732
  type: 'string',
581
733
  description: 'Account name',
582
- example: 'Assets:Bank:Checking'
734
+ example: 'Assets:Checking'
583
735
  },
584
736
  units: {
585
737
  type: 'string',
@@ -591,6 +743,15 @@ export const $PostingResponseDto = {
591
743
  type: 'string',
592
744
  description: 'Currency',
593
745
  example: 'USD'
746
+ },
747
+ cost: {
748
+ description:
749
+ 'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
750
+ allOf: [
751
+ {
752
+ $ref: '#/components/schemas/CostDetailDto'
753
+ }
754
+ ]
594
755
  }
595
756
  },
596
757
  required: ['account']
@@ -841,6 +1002,85 @@ export const $BatchTransactionResponseDto = {
841
1002
  required: ['succeeded', 'failed']
842
1003
  } as const;
843
1004
 
1005
+ export const $CorrectTransactionDto = {
1006
+ type: 'object',
1007
+ properties: {
1008
+ date: {
1009
+ type: 'string',
1010
+ description: 'Transaction date (ISO 8601 format)',
1011
+ example: '2024-11-28'
1012
+ },
1013
+ flag: {
1014
+ type: 'string',
1015
+ description: 'Transaction flag: * (cleared), ! (pending)',
1016
+ enum: ['*', '!'],
1017
+ example: '*'
1018
+ },
1019
+ payee: {
1020
+ type: 'string',
1021
+ description: 'Payee name',
1022
+ example: 'Whole Foods Market'
1023
+ },
1024
+ narration: {
1025
+ type: 'string',
1026
+ description: 'Transaction narration/description',
1027
+ example: 'Grocery shopping'
1028
+ },
1029
+ tags: {
1030
+ description: 'Transaction tags (without # prefix)',
1031
+ example: ['vacation', 'personal'],
1032
+ type: 'array',
1033
+ items: {
1034
+ type: 'string'
1035
+ }
1036
+ },
1037
+ links: {
1038
+ description: 'Transaction links (without ^ prefix)',
1039
+ example: ['invoice-123'],
1040
+ type: 'array',
1041
+ items: {
1042
+ type: 'string'
1043
+ }
1044
+ },
1045
+ postings: {
1046
+ description:
1047
+ 'Transaction postings (minimum 1, typically 2 for double-entry)',
1048
+ type: 'array',
1049
+ items: {
1050
+ $ref: '#/components/schemas/CreatePostingDto'
1051
+ }
1052
+ },
1053
+ meta: {
1054
+ type: 'object',
1055
+ description: 'Transaction-level metadata',
1056
+ example: {
1057
+ invoice: '12345'
1058
+ }
1059
+ },
1060
+ idempotencyKey: {
1061
+ type: 'string',
1062
+ description:
1063
+ 'Unique key for idempotent transaction creation. If provided, duplicate requests with the same key will return the existing transaction.',
1064
+ example: 'import-2024-01-15-batch-001',
1065
+ maxLength: 128
1066
+ },
1067
+ autoCreateAccounts: {
1068
+ type: 'boolean',
1069
+ description:
1070
+ 'Auto-create accounts if not found. When true, missing accounts will be automatically created. When false (default for API), missing accounts will cause a validation error. Set to true for quick entry scenarios where you want to create accounts on-the-fly.',
1071
+ default: true,
1072
+ example: true
1073
+ },
1074
+ correctionReason: {
1075
+ type: 'string',
1076
+ description: 'Reason for correcting/superseding the original transaction',
1077
+ example: 'Wrong amount — corrected from receipt',
1078
+ maxLength: 500
1079
+ }
1080
+ },
1081
+ required: ['date', 'narration', 'postings']
1082
+ } as const;
1083
+
844
1084
  export const $PostingDetailDto = {
845
1085
  type: 'object',
846
1086
  properties: {
@@ -854,10 +1094,10 @@ export const $PostingDetailDto = {
854
1094
  description: 'Account ID',
855
1095
  example: 'clh1234567890abcdef'
856
1096
  },
857
- accountName: {
1097
+ account: {
858
1098
  type: 'string',
859
- description: 'Account name',
860
- example: 'Assets:Bank:Checking'
1099
+ description: 'Fully-qualified Beancount account path',
1100
+ example: 'Assets:Checking'
861
1101
  },
862
1102
  units: {
863
1103
  type: 'string',
@@ -885,6 +1125,15 @@ export const $PostingDetailDto = {
885
1125
  description: 'Cost date',
886
1126
  example: '2024-01-15'
887
1127
  },
1128
+ cost: {
1129
+ description:
1130
+ 'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
1131
+ allOf: [
1132
+ {
1133
+ $ref: '#/components/schemas/CostDetailDto'
1134
+ }
1135
+ ]
1136
+ },
888
1137
  priceAmount: {
889
1138
  type: 'string',
890
1139
  description: 'Price amount',
@@ -905,7 +1154,7 @@ export const $PostingDetailDto = {
905
1154
  description: 'Posting metadata'
906
1155
  }
907
1156
  },
908
- required: ['id', 'accountId', 'accountName']
1157
+ required: ['id', 'accountId', 'account']
909
1158
  } as const;
910
1159
 
911
1160
  export const $TransactionDetailDto = {
@@ -1011,6 +1260,18 @@ export const $TransactionDetailDto = {
1011
1260
  type: 'string',
1012
1261
  description: 'Correction reason (if voided or superseded)',
1013
1262
  example: 'Duplicate entry'
1263
+ },
1264
+ supersededBy: {
1265
+ type: 'string',
1266
+ description:
1267
+ 'ID of the transaction that supersedes this one (set when status=SUPERSEDED)',
1268
+ example: 'clh1234567890abcdef'
1269
+ },
1270
+ originalTxn: {
1271
+ type: 'string',
1272
+ description:
1273
+ 'ID of the transaction this one corrected/replaced (back-link on the replacement)',
1274
+ example: 'clh1234567890abcdef'
1014
1275
  }
1015
1276
  },
1016
1277
  required: [
@@ -1025,23 +1286,94 @@ export const $TransactionDetailDto = {
1025
1286
  ]
1026
1287
  } as const;
1027
1288
 
1028
- export const $TransactionListResponseDto = {
1289
+ export const $BalanceByCurrencyDto = {
1029
1290
  type: 'object',
1030
1291
  properties: {
1031
- data: {
1032
- description: 'List of transactions',
1033
- type: 'array',
1034
- items: {
1035
- $ref: '#/components/schemas/TransactionDetailDto'
1036
- }
1037
- },
1038
- total: {
1039
- type: 'number',
1040
- description: 'Total count of matching transactions',
1041
- example: 100
1292
+ currency: {
1293
+ type: 'string',
1294
+ description: 'ISO 4217 currency code',
1295
+ example: 'CNY'
1042
1296
  },
1043
- limit: {
1044
- type: 'number',
1297
+ balance: {
1298
+ type: 'string',
1299
+ description: 'Balance amount',
1300
+ example: '50000.00'
1301
+ }
1302
+ },
1303
+ required: ['currency', 'balance']
1304
+ } as const;
1305
+
1306
+ export const $ExchangeRateWarningDto = {
1307
+ type: 'object',
1308
+ properties: {
1309
+ type: {
1310
+ type: 'string',
1311
+ description: 'Warning type',
1312
+ example: 'MISSING_EXCHANGE_RATE'
1313
+ },
1314
+ currency: {
1315
+ type: 'string',
1316
+ description: 'Currency without exchange rate',
1317
+ example: 'EUR'
1318
+ },
1319
+ totalAmount: {
1320
+ type: 'string',
1321
+ description: 'Total amount affected',
1322
+ example: '1000.00'
1323
+ }
1324
+ },
1325
+ required: ['type', 'currency', 'totalAmount']
1326
+ } as const;
1327
+
1328
+ export const $TransactionListSummaryDto = {
1329
+ type: 'object',
1330
+ properties: {
1331
+ totalAmount: {
1332
+ type: 'string',
1333
+ description:
1334
+ '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.',
1335
+ example: '-6000.00'
1336
+ },
1337
+ currency: {
1338
+ type: 'string',
1339
+ description: 'Base currency (ISO 4217)',
1340
+ example: 'CNY'
1341
+ },
1342
+ balanceByCurrency: {
1343
+ description: 'Raw (unconverted) balance per currency',
1344
+ type: 'array',
1345
+ items: {
1346
+ $ref: '#/components/schemas/BalanceByCurrencyDto'
1347
+ }
1348
+ },
1349
+ warnings: {
1350
+ description: 'Currencies missing an FX rate (omitted when empty)',
1351
+ type: 'array',
1352
+ items: {
1353
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
1354
+ }
1355
+ }
1356
+ },
1357
+ required: ['totalAmount', 'currency', 'balanceByCurrency']
1358
+ } as const;
1359
+
1360
+ export const $TransactionListResponseDto = {
1361
+ type: 'object',
1362
+ properties: {
1363
+ data: {
1364
+ description: 'List of transactions',
1365
+ type: 'array',
1366
+ items: {
1367
+ $ref: '#/components/schemas/TransactionDetailDto'
1368
+ }
1369
+ },
1370
+ total: {
1371
+ type: 'number',
1372
+ description: 'Total count of matching transactions',
1373
+ example: 100
1374
+ },
1375
+ limit: {
1376
+ type: 'number',
1045
1377
  description: 'Number of items per page',
1046
1378
  example: 20
1047
1379
  },
@@ -1049,6 +1381,15 @@ export const $TransactionListResponseDto = {
1049
1381
  type: 'number',
1050
1382
  description: 'Number of items skipped',
1051
1383
  example: 0
1384
+ },
1385
+ summary: {
1386
+ description:
1387
+ '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.',
1388
+ allOf: [
1389
+ {
1390
+ $ref: '#/components/schemas/TransactionListSummaryDto'
1391
+ }
1392
+ ]
1052
1393
  }
1053
1394
  },
1054
1395
  required: ['data', 'total', 'limit', 'offset']
@@ -1148,7 +1489,7 @@ export const $BalanceResponseDto = {
1148
1489
  account: {
1149
1490
  type: 'string',
1150
1491
  description: 'Account name',
1151
- example: 'Assets:Bank:Checking'
1492
+ example: 'Assets:Checking'
1152
1493
  },
1153
1494
  balance: {
1154
1495
  type: 'string',
@@ -1175,7 +1516,7 @@ export const $MultiCurrencyBalanceResponseDto = {
1175
1516
  account: {
1176
1517
  type: 'string',
1177
1518
  description: 'Account name',
1178
- example: 'Assets:Bank:Checking'
1519
+ example: 'Assets:Checking'
1179
1520
  },
1180
1521
  balances: {
1181
1522
  type: 'object',
@@ -1231,7 +1572,7 @@ export const $TransactionSummaryDto = {
1231
1572
  accountName: {
1232
1573
  type: 'string',
1233
1574
  description: 'Source account name (first posting)',
1234
- example: 'Assets:Bank:Checking'
1575
+ example: 'Assets:Checking'
1235
1576
  },
1236
1577
  sourceType: {
1237
1578
  type: 'string',
@@ -1633,7 +1974,8 @@ export const $ResolveResultDto = {
1633
1974
  },
1634
1975
  resolutionId: {
1635
1976
  type: 'string',
1636
- description: 'Resolution ID for undo'
1977
+ description:
1978
+ 'Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).'
1637
1979
  },
1638
1980
  canUndo: {
1639
1981
  type: 'boolean',
@@ -1651,7 +1993,7 @@ export const $ResolveResultDto = {
1651
1993
  example: 'rule_01HXK5V8N2M3P4Q5R6S7T8U9V0'
1652
1994
  }
1653
1995
  },
1654
- required: ['success', 'resolutionId', 'canUndo', 'undoDeadline']
1996
+ required: ['success']
1655
1997
  } as const;
1656
1998
 
1657
1999
  export const $UndoResultDto = {
@@ -2522,6 +2864,163 @@ export const $UpdateCommodityDto = {
2522
2864
  }
2523
2865
  } as const;
2524
2866
 
2867
+ export const $CreateBeanPriceDto = {
2868
+ type: 'object',
2869
+ properties: {
2870
+ currency: {
2871
+ type: 'string',
2872
+ description: 'Currency being priced (e.g., USD, AAPL, BTC)',
2873
+ example: 'USD'
2874
+ },
2875
+ quoteCurrency: {
2876
+ type: 'string',
2877
+ description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
2878
+ example: 'CNY'
2879
+ },
2880
+ amount: {
2881
+ type: 'number',
2882
+ description:
2883
+ 'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
2884
+ example: 175.5,
2885
+ minimum: 0
2886
+ },
2887
+ date: {
2888
+ type: 'string',
2889
+ description: 'Price date (ISO 8601 format)',
2890
+ example: '2024-11-05'
2891
+ },
2892
+ metadata: {
2893
+ type: 'object',
2894
+ description:
2895
+ 'Metadata (validated by Zod schema, max field lengths enforced)',
2896
+ example: {
2897
+ source: 'MANUAL',
2898
+ note: 'Bank valuation report',
2899
+ confidence: 0.95
2900
+ }
2901
+ }
2902
+ },
2903
+ required: ['currency', 'quoteCurrency', 'amount', 'date']
2904
+ } as const;
2905
+
2906
+ export const $PriceResponseDto = {
2907
+ type: 'object',
2908
+ properties: {
2909
+ id: {
2910
+ type: 'string',
2911
+ description: 'Unique identifier',
2912
+ example: 'uuid-123-456'
2913
+ },
2914
+ userId: {
2915
+ type: 'string',
2916
+ description: 'User ID (owner of the price)',
2917
+ example: 'user-123'
2918
+ },
2919
+ currency: {
2920
+ type: 'string',
2921
+ description: 'Currency being priced (e.g., USD, AAPL, BTC)',
2922
+ example: 'BTC'
2923
+ },
2924
+ quoteCurrency: {
2925
+ type: 'string',
2926
+ description: 'Quote currency (pricing currency, e.g., USD, CNY)',
2927
+ example: 'USD'
2928
+ },
2929
+ amount: {
2930
+ type: 'number',
2931
+ description:
2932
+ 'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
2933
+ example: 50000
2934
+ },
2935
+ date: {
2936
+ type: 'string',
2937
+ description:
2938
+ 'Price date (ISO 8601 format). Represents the date this price was valid.',
2939
+ example: '2024-01-01',
2940
+ format: 'date'
2941
+ },
2942
+ meta: {
2943
+ type: 'object',
2944
+ description:
2945
+ 'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
2946
+ example: {
2947
+ source: 'MANUAL',
2948
+ note: 'User-defined price',
2949
+ confidence: 1
2950
+ }
2951
+ },
2952
+ createdAt: {
2953
+ format: 'date-time',
2954
+ type: 'string',
2955
+ description: 'Creation timestamp',
2956
+ example: '2024-11-03T10:00:00Z'
2957
+ },
2958
+ updatedAt: {
2959
+ format: 'date-time',
2960
+ type: 'string',
2961
+ description: 'Last update timestamp',
2962
+ example: '2024-11-03T10:00:00Z'
2963
+ }
2964
+ },
2965
+ required: [
2966
+ 'id',
2967
+ 'userId',
2968
+ 'currency',
2969
+ 'quoteCurrency',
2970
+ 'amount',
2971
+ 'date',
2972
+ 'meta',
2973
+ 'createdAt',
2974
+ 'updatedAt'
2975
+ ]
2976
+ } as const;
2977
+
2978
+ export const $PriceListResponseDto = {
2979
+ type: 'object',
2980
+ properties: {
2981
+ items: {
2982
+ description: 'List of prices',
2983
+ type: 'array',
2984
+ items: {
2985
+ $ref: '#/components/schemas/PriceResponseDto'
2986
+ }
2987
+ },
2988
+ total: {
2989
+ type: 'number',
2990
+ description: 'Total number of prices',
2991
+ example: 42
2992
+ }
2993
+ },
2994
+ required: ['items', 'total']
2995
+ } as const;
2996
+
2997
+ export const $UpdateBeanPriceDto = {
2998
+ type: 'object',
2999
+ properties: {
3000
+ currency: {
3001
+ type: 'string',
3002
+ description: 'Currency being priced'
3003
+ },
3004
+ quoteCurrency: {
3005
+ type: 'string',
3006
+ description: 'Quote currency (pricing currency)'
3007
+ },
3008
+ amount: {
3009
+ type: 'number',
3010
+ description: 'Price amount (MUST be >= 0 per Beancount spec)',
3011
+ minimum: 0
3012
+ },
3013
+ date: {
3014
+ type: 'string',
3015
+ description: 'Price date (ISO 8601 format)'
3016
+ },
3017
+ metadata: {
3018
+ type: 'object',
3019
+ description: 'Metadata'
3020
+ }
3021
+ }
3022
+ } as const;
3023
+
2525
3024
  export const $CreateRecurringRuleDto = {
2526
3025
  type: 'object',
2527
3026
  properties: {
@@ -3293,43 +3792,490 @@ export const $ForecastResponseDto = {
3293
3792
  ]
3294
3793
  } as const;
3295
3794
 
3296
- export const $CreateTransactionRuleDto = {
3795
+ export const $CurrencyBalanceDto = {
3297
3796
  type: 'object',
3298
3797
  properties: {
3299
- name: {
3798
+ currency: {
3300
3799
  type: 'string',
3301
- minLength: 1,
3302
- maxLength: 100
3800
+ description: 'ISO 4217 currency code',
3801
+ example: 'CNY'
3303
3802
  },
3304
- description: {
3803
+ balance: {
3305
3804
  type: 'string',
3306
- maxLength: 500
3805
+ description: 'Balance amount',
3806
+ example: '500000.00'
3807
+ }
3808
+ },
3809
+ required: ['currency', 'balance']
3810
+ } as const;
3811
+
3812
+ export const $TimeSeriesPointDto = {
3813
+ type: 'object',
3814
+ properties: {
3815
+ date: {
3816
+ type: 'string',
3817
+ description: 'Date in YYYY-MM-DD format',
3818
+ example: '2024-06-15'
3307
3819
  },
3308
- narrationKeywords: {
3309
- items: {
3310
- type: 'array'
3311
- },
3312
- maxItems: 50,
3313
- type: 'array'
3820
+ value: {
3821
+ type: 'string',
3822
+ description: 'Value at this date (in base currency)',
3823
+ example: '500000.00'
3314
3824
  },
3315
- payeeKeywords: {
3316
- items: {
3317
- type: 'array'
3318
- },
3319
- maxItems: 50,
3320
- type: 'array'
3825
+ change: {
3826
+ type: 'object',
3827
+ description: 'Change from previous point',
3828
+ example: '5000.00'
3321
3829
  },
3322
- categoryKeywords: {
3323
- items: {
3324
- type: 'array'
3325
- },
3326
- maxItems: 50,
3327
- type: 'array'
3830
+ assets: {
3831
+ type: 'string',
3832
+ description: 'Total assets at this date (in base currency)',
3833
+ example: '494338.00'
3328
3834
  },
3329
- methodKeywords: {
3330
- items: {
3331
- type: 'array'
3332
- },
3835
+ liabilities: {
3836
+ type: 'string',
3837
+ description: 'Total liabilities at this date (in base currency)',
3838
+ example: '310098.00'
3839
+ },
3840
+ byCurrency: {
3841
+ description: 'Multi-currency breakdown for this point',
3842
+ type: 'array',
3843
+ items: {
3844
+ $ref: '#/components/schemas/CurrencyBalanceDto'
3845
+ }
3846
+ }
3847
+ },
3848
+ required: ['date', 'value']
3849
+ } as const;
3850
+
3851
+ export const $TrendSummaryDto = {
3852
+ type: 'object',
3853
+ properties: {
3854
+ startValue: {
3855
+ type: 'string',
3856
+ description: 'Value at start of period',
3857
+ example: '450000.00'
3858
+ },
3859
+ endValue: {
3860
+ type: 'string',
3861
+ description: 'Value at end of period',
3862
+ example: '500000.00'
3863
+ },
3864
+ totalChange: {
3865
+ type: 'string',
3866
+ description: 'Total change over period',
3867
+ example: '50000.00'
3868
+ },
3869
+ totalChangePercentage: {
3870
+ type: 'string',
3871
+ description: 'Total change percentage',
3872
+ example: '+11.11%'
3873
+ }
3874
+ },
3875
+ required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
3876
+ } as const;
3877
+
3878
+ export const $MultiCurrencyPointDto = {
3879
+ type: 'object',
3880
+ properties: {
3881
+ date: {
3882
+ type: 'string',
3883
+ description: 'Date in YYYY-MM-DD format',
3884
+ example: '2024-06-15'
3885
+ },
3886
+ byCurrency: {
3887
+ description: 'Balances by currency',
3888
+ type: 'array',
3889
+ items: {
3890
+ $ref: '#/components/schemas/CurrencyBalanceDto'
3891
+ }
3892
+ }
3893
+ },
3894
+ required: ['date', 'byCurrency']
3895
+ } as const;
3896
+
3897
+ export const $PortfolioTrendsResponseDto = {
3898
+ type: 'object',
3899
+ properties: {
3900
+ series: {
3901
+ description: 'Time series data points',
3902
+ type: 'array',
3903
+ items: {
3904
+ $ref: '#/components/schemas/TimeSeriesPointDto'
3905
+ }
3906
+ },
3907
+ summary: {
3908
+ description: 'Period summary',
3909
+ allOf: [
3910
+ {
3911
+ $ref: '#/components/schemas/TrendSummaryDto'
3912
+ }
3913
+ ]
3914
+ },
3915
+ period: {
3916
+ type: 'string',
3917
+ description: 'Period requested',
3918
+ example: '6m'
3919
+ },
3920
+ granularity: {
3921
+ type: 'string',
3922
+ description: 'Data granularity',
3923
+ example: 'month'
3924
+ },
3925
+ currency: {
3926
+ type: 'string',
3927
+ description: 'Base currency for converted values',
3928
+ example: 'CNY'
3929
+ },
3930
+ byCurrency: {
3931
+ description:
3932
+ 'Multi-currency time series (each point has currency breakdown)',
3933
+ type: 'array',
3934
+ items: {
3935
+ $ref: '#/components/schemas/MultiCurrencyPointDto'
3936
+ }
3937
+ },
3938
+ warnings: {
3939
+ description: 'Exchange rate warnings',
3940
+ type: 'array',
3941
+ items: {
3942
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
3943
+ }
3944
+ }
3945
+ },
3946
+ required: ['series', 'summary', 'period', 'granularity', 'currency']
3947
+ } as const;
3948
+
3949
+ export const $CashFlowPointDto = {
3950
+ type: 'object',
3951
+ properties: {
3952
+ month: {
3953
+ type: 'string',
3954
+ description: 'Month key (YYYY-MM)',
3955
+ example: '2024-03'
3956
+ },
3957
+ income: {
3958
+ type: 'string',
3959
+ description: 'Income in base currency (absolute, converted)',
3960
+ example: '10000.00'
3961
+ },
3962
+ expense: {
3963
+ type: 'string',
3964
+ description: 'Expense in base currency (absolute, converted)',
3965
+ example: '5000.00'
3966
+ },
3967
+ netSavings: {
3968
+ type: 'string',
3969
+ description: 'netSavings = income − expense (savings positive)',
3970
+ example: '5000.00'
3971
+ }
3972
+ },
3973
+ required: ['month', 'income', 'expense', 'netSavings']
3974
+ } as const;
3975
+
3976
+ export const $CashFlowTrendSummaryDto = {
3977
+ type: 'object',
3978
+ properties: {
3979
+ totalIncome: {
3980
+ type: 'string',
3981
+ description: 'Total income across the period',
3982
+ example: '60000.00'
3983
+ },
3984
+ totalExpense: {
3985
+ type: 'string',
3986
+ description: 'Total expense across the period',
3987
+ example: '30000.00'
3988
+ },
3989
+ totalNetSavings: {
3990
+ type: 'string',
3991
+ description: 'income − expense across the period',
3992
+ example: '30000.00'
3993
+ },
3994
+ averageMonthlyNetSavings: {
3995
+ type: 'string',
3996
+ description:
3997
+ 'totalNetSavings divided by the window length (N months, incl. zero-filled)',
3998
+ example: '5000.00'
3999
+ }
4000
+ },
4001
+ required: [
4002
+ 'totalIncome',
4003
+ 'totalExpense',
4004
+ 'totalNetSavings',
4005
+ 'averageMonthlyNetSavings'
4006
+ ]
4007
+ } as const;
4008
+
4009
+ export const $CashFlowTrendsResponseDto = {
4010
+ type: 'object',
4011
+ properties: {
4012
+ series: {
4013
+ description:
4014
+ 'Monthly cash-flow series (fixed N-month window, zero-filled)',
4015
+ type: 'array',
4016
+ items: {
4017
+ $ref: '#/components/schemas/CashFlowPointDto'
4018
+ }
4019
+ },
4020
+ summary: {
4021
+ description: 'Period totals',
4022
+ allOf: [
4023
+ {
4024
+ $ref: '#/components/schemas/CashFlowTrendSummaryDto'
4025
+ }
4026
+ ]
4027
+ },
4028
+ period: {
4029
+ type: 'string',
4030
+ description: 'Period requested',
4031
+ example: '6m'
4032
+ },
4033
+ granularity: {
4034
+ type: 'string',
4035
+ description: 'Data granularity (v1 returns month buckets)',
4036
+ example: 'month'
4037
+ },
4038
+ currency: {
4039
+ type: 'string',
4040
+ description: 'Base currency for converted values',
4041
+ example: 'CNY'
4042
+ },
4043
+ warnings: {
4044
+ description: 'Exchange rate warnings (e.g. missing rate for a currency)',
4045
+ type: 'array',
4046
+ items: {
4047
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
4048
+ }
4049
+ }
4050
+ },
4051
+ required: ['series', 'summary', 'period', 'granularity', 'currency']
4052
+ } as const;
4053
+
4054
+ export const $GenerateSnapshotBody = {
4055
+ type: 'object',
4056
+ properties: {}
4057
+ } as const;
4058
+
4059
+ export const $GenerateSnapshotResponse = {
4060
+ type: 'object',
4061
+ properties: {}
4062
+ } as const;
4063
+
4064
+ export const $BackfillSnapshotsBody = {
4065
+ type: 'object',
4066
+ properties: {}
4067
+ } as const;
4068
+
4069
+ export const $BackfillSnapshotsResponse = {
4070
+ type: 'object',
4071
+ properties: {}
4072
+ } as const;
4073
+
4074
+ export const $DeleteOwnUserDto = {
4075
+ type: 'object',
4076
+ properties: {
4077
+ accessToken: {
4078
+ type: 'string',
4079
+ description: 'Access token for user verification',
4080
+ example: 'abc123xyz'
4081
+ }
4082
+ },
4083
+ required: ['accessToken']
4084
+ } as const;
4085
+
4086
+ export const $SignupDto = {
4087
+ type: 'object',
4088
+ properties: {
4089
+ turnstileToken: {
4090
+ type: 'string',
4091
+ description:
4092
+ 'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
4093
+ example: '0.abc123def456...'
4094
+ }
4095
+ }
4096
+ } as const;
4097
+
4098
+ export const $SignupResponseDto = {
4099
+ type: 'object',
4100
+ properties: {
4101
+ authToken: {
4102
+ type: 'string',
4103
+ description: 'JWT auth token',
4104
+ example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
4105
+ },
4106
+ accessToken: {
4107
+ type: 'string',
4108
+ description: 'Auto-generated access token'
4109
+ },
4110
+ role: {
4111
+ type: 'string',
4112
+ description: 'Assigned user role',
4113
+ enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
4114
+ }
4115
+ },
4116
+ required: ['authToken', 'accessToken', 'role']
4117
+ } as const;
4118
+
4119
+ export const $UpdateUserSettingDto = {
4120
+ type: 'object',
4121
+ properties: {
4122
+ secId: {
4123
+ type: 'number',
4124
+ description: 'Security ID'
4125
+ },
4126
+ annualInterestRate: {
4127
+ type: 'number',
4128
+ description: 'Annual interest rate',
4129
+ example: 0.05
4130
+ },
4131
+ currency: {
4132
+ type: 'string',
4133
+ description: 'Currency code',
4134
+ example: 'USD'
4135
+ },
4136
+ baseCurrency: {
4137
+ type: 'string',
4138
+ description: 'Base currency code',
4139
+ example: 'USD'
4140
+ },
4141
+ benchmark: {
4142
+ type: 'string',
4143
+ description: 'Benchmark symbol',
4144
+ example: 'SPY'
4145
+ },
4146
+ colorScheme: {
4147
+ type: 'string',
4148
+ description: 'Color scheme',
4149
+ enum: ['DARK', 'LIGHT']
4150
+ },
4151
+ dateRange: {
4152
+ type: 'string',
4153
+ description: 'Date range filter',
4154
+ example: '1y'
4155
+ },
4156
+ emergencyFund: {
4157
+ type: 'number',
4158
+ description: 'Emergency fund amount',
4159
+ example: 10000
4160
+ },
4161
+ 'filters.accounts': {
4162
+ description: 'Account filter IDs',
4163
+ type: 'array',
4164
+ items: {
4165
+ type: 'string'
4166
+ }
4167
+ },
4168
+ 'filters.assetClasses': {
4169
+ description: 'Asset class filters',
4170
+ type: 'array',
4171
+ items: {
4172
+ type: 'string'
4173
+ }
4174
+ },
4175
+ 'filters.dataSource': {
4176
+ type: 'string',
4177
+ description: 'Data source filter'
4178
+ },
4179
+ 'filters.symbol': {
4180
+ type: 'string',
4181
+ description: 'Symbol filter'
4182
+ },
4183
+ 'filters.tags': {
4184
+ description: 'Tag filters',
4185
+ type: 'array',
4186
+ items: {
4187
+ type: 'string'
4188
+ }
4189
+ },
4190
+ isExperimentalFeatures: {
4191
+ type: 'boolean',
4192
+ description: 'Enable experimental features'
4193
+ },
4194
+ isRestrictedView: {
4195
+ type: 'boolean',
4196
+ description: 'Enable restricted view mode'
4197
+ },
4198
+ language: {
4199
+ type: 'string',
4200
+ description: 'Language code',
4201
+ example: 'en'
4202
+ },
4203
+ locale: {
4204
+ type: 'string',
4205
+ description: 'Locale code',
4206
+ example: 'en-US'
4207
+ },
4208
+ projectedTotalAmount: {
4209
+ type: 'number',
4210
+ description: 'Projected total amount',
4211
+ example: 1000000
4212
+ },
4213
+ retirementDate: {
4214
+ type: 'string',
4215
+ description: 'Retirement date in ISO 8601 format',
4216
+ example: '2050-01-01'
4217
+ },
4218
+ savingsRate: {
4219
+ type: 'number',
4220
+ description: 'Savings rate percentage',
4221
+ example: 0.2
4222
+ },
4223
+ viewMode: {
4224
+ type: 'string',
4225
+ description: 'View mode',
4226
+ enum: ['DEFAULT', 'ZEN']
4227
+ }
4228
+ }
4229
+ } as const;
4230
+
4231
+ export const $UpdatePropertyDto = {
4232
+ type: 'object',
4233
+ properties: {
4234
+ value: {
4235
+ type: 'string',
4236
+ description: 'Property value'
4237
+ }
4238
+ },
4239
+ required: ['value']
4240
+ } as const;
4241
+
4242
+ export const $CreateTransactionRuleDto = {
4243
+ type: 'object',
4244
+ properties: {
4245
+ name: {
4246
+ type: 'string',
4247
+ minLength: 1,
4248
+ maxLength: 100
4249
+ },
4250
+ description: {
4251
+ type: 'string',
4252
+ maxLength: 500
4253
+ },
4254
+ narrationKeywords: {
4255
+ items: {
4256
+ type: 'array'
4257
+ },
4258
+ maxItems: 50,
4259
+ type: 'array'
4260
+ },
4261
+ payeeKeywords: {
4262
+ items: {
4263
+ type: 'array'
4264
+ },
4265
+ maxItems: 50,
4266
+ type: 'array'
4267
+ },
4268
+ categoryKeywords: {
4269
+ items: {
4270
+ type: 'array'
4271
+ },
4272
+ maxItems: 50,
4273
+ type: 'array'
4274
+ },
4275
+ methodKeywords: {
4276
+ items: {
4277
+ type: 'array'
4278
+ },
3333
4279
  maxItems: 50,
3334
4280
  description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
3335
4281
  type: 'array'
@@ -3942,151 +4888,393 @@ export const $TestRuleResponseDto = {
3942
4888
  required: ['ruleId', 'matches', 'confidence', 'matchDetails']
3943
4889
  } as const;
3944
4890
 
3945
- export const $DeleteOwnUserDto = {
4891
+ export const $CreateBeanEventDto = {
3946
4892
  type: 'object',
3947
4893
  properties: {
3948
- accessToken: {
4894
+ date: {
3949
4895
  type: 'string',
3950
- description: 'Access token for user verification',
3951
- example: 'abc123xyz'
4896
+ description: 'Life event date (ISO 8601)',
4897
+ example: '2024-03-15'
4898
+ },
4899
+ type: {
4900
+ type: 'string',
4901
+ description:
4902
+ 'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
4903
+ example: 'employer'
4904
+ },
4905
+ description: {
4906
+ type: 'string',
4907
+ description:
4908
+ 'Life event description. Empty string is a VALID value (distinct from absence).',
4909
+ example: 'Acme Corp'
4910
+ },
4911
+ meta: {
4912
+ type: 'object',
4913
+ description:
4914
+ 'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
4915
+ example: {
4916
+ note: 'Promotion'
4917
+ }
3952
4918
  }
3953
4919
  },
3954
- required: ['accessToken']
4920
+ required: ['date', 'type', 'description']
3955
4921
  } as const;
3956
4922
 
3957
- export const $SignupDto = {
4923
+ export const $EventResponseDto = {
3958
4924
  type: 'object',
3959
4925
  properties: {
3960
- turnstileToken: {
4926
+ id: {
4927
+ type: 'string',
4928
+ description: 'Unique identifier',
4929
+ example: 'uuid-123-456'
4930
+ },
4931
+ userId: {
4932
+ type: 'string',
4933
+ description: 'User ID (owner of the life event)',
4934
+ example: 'user-123'
4935
+ },
4936
+ date: {
4937
+ type: 'string',
4938
+ description: 'Life event date (ISO 8601 format)',
4939
+ example: '2024-03-15',
4940
+ format: 'date'
4941
+ },
4942
+ type: {
3961
4943
  type: 'string',
3962
4944
  description:
3963
- 'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
3964
- example: '0.abc123def456...'
4945
+ 'Life event type (user-defined, e.g., "employer", "location")',
4946
+ example: 'employer'
4947
+ },
4948
+ description: {
4949
+ type: 'string',
4950
+ description:
4951
+ 'Life event description. May be an empty string (a valid value distinct from absence).',
4952
+ example: 'Acme Corp'
4953
+ },
4954
+ meta: {
4955
+ type: 'object',
4956
+ description: 'Product-side metadata (free-form JSON)',
4957
+ example: {
4958
+ note: 'Promotion'
4959
+ }
4960
+ },
4961
+ createdAt: {
4962
+ format: 'date-time',
4963
+ type: 'string',
4964
+ description: 'Creation timestamp',
4965
+ example: '2024-03-15T10:00:00Z'
4966
+ },
4967
+ updatedAt: {
4968
+ format: 'date-time',
4969
+ type: 'string',
4970
+ description:
4971
+ 'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
4972
+ example: '2024-03-15T10:00:00Z'
4973
+ }
4974
+ },
4975
+ required: [
4976
+ 'id',
4977
+ 'userId',
4978
+ 'date',
4979
+ 'type',
4980
+ 'description',
4981
+ 'meta',
4982
+ 'createdAt',
4983
+ 'updatedAt'
4984
+ ]
4985
+ } as const;
4986
+
4987
+ export const $EventListResponseDto = {
4988
+ type: 'object',
4989
+ properties: {
4990
+ items: {
4991
+ description: 'List of life events',
4992
+ type: 'array',
4993
+ items: {
4994
+ $ref: '#/components/schemas/EventResponseDto'
4995
+ }
4996
+ },
4997
+ total: {
4998
+ type: 'number',
4999
+ description: 'Total number of life events matching the query',
5000
+ example: 42
5001
+ }
5002
+ },
5003
+ required: ['items', 'total']
5004
+ } as const;
5005
+
5006
+ export const $UpdateBeanEventDto = {
5007
+ type: 'object',
5008
+ properties: {
5009
+ date: {
5010
+ type: 'string',
5011
+ description: 'Life event date (ISO 8601)'
5012
+ },
5013
+ type: {
5014
+ type: 'string',
5015
+ description: 'Life event type (user-defined)'
5016
+ },
5017
+ description: {
5018
+ type: 'string',
5019
+ description:
5020
+ 'Life event description. Empty string is a VALID value (distinct from absence).'
5021
+ },
5022
+ meta: {
5023
+ type: 'object',
5024
+ description: 'Product-side metadata (free-form JSON)'
3965
5025
  }
3966
5026
  }
3967
5027
  } as const;
3968
5028
 
3969
- export const $UpdateUserSettingDto = {
5029
+ export const $OnboardingAccountDto = {
5030
+ type: 'object',
5031
+ properties: {
5032
+ path: {
5033
+ type: 'string',
5034
+ description:
5035
+ 'Account path (Assets/Liabilities only; format validated by the account service)',
5036
+ example: 'Assets:Checking'
5037
+ },
5038
+ currency: {
5039
+ type: 'string',
5040
+ description: 'ISO 4217 currency code (3 letters)',
5041
+ example: 'USD'
5042
+ },
5043
+ openingBalance: {
5044
+ type: 'string',
5045
+ description:
5046
+ 'Opening balance as a non-negative Decimal string (e.g. "1000.00")',
5047
+ example: '1000.00'
5048
+ },
5049
+ platformId: {
5050
+ type: 'string',
5051
+ description:
5052
+ 'Platform ID to bind the account to (references Platform.id); omit for unbound',
5053
+ example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
5054
+ }
5055
+ },
5056
+ required: ['path', 'currency']
5057
+ } as const;
5058
+
5059
+ export const $OnboardingDto = {
5060
+ type: 'object',
5061
+ properties: {
5062
+ accounts: {
5063
+ description: 'Asset/Liability accounts to register with opening balances',
5064
+ type: 'array',
5065
+ items: {
5066
+ $ref: '#/components/schemas/OnboardingAccountDto'
5067
+ }
5068
+ },
5069
+ skipAssetRegistration: {
5070
+ type: 'boolean',
5071
+ description:
5072
+ 'Skip asset registration; only bootstrap the core account set',
5073
+ default: false
5074
+ }
5075
+ }
5076
+ } as const;
5077
+
5078
+ export const $ActualBalanceDto = {
5079
+ type: 'object',
5080
+ properties: {
5081
+ amount: {
5082
+ type: 'string',
5083
+ description:
5084
+ 'Actual balance amount as a decimal string (preserves precision for tolerance inference).',
5085
+ example: '1234.56'
5086
+ },
5087
+ ccy: {
5088
+ type: 'string',
5089
+ description: 'Currency code (ISO 4217 or commodity ticker).',
5090
+ example: 'CNY'
5091
+ }
5092
+ },
5093
+ required: ['amount', 'ccy']
5094
+ } as const;
5095
+
5096
+ export const $ComputeReconciliationDto = {
5097
+ type: 'object',
5098
+ properties: {
5099
+ accountId: {
5100
+ type: 'string',
5101
+ description: 'BeanAccount id to reconcile.'
5102
+ },
5103
+ asOfDate: {
5104
+ type: 'string',
5105
+ description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
5106
+ example: '2026-07-24'
5107
+ },
5108
+ actualBalance: {
5109
+ description: 'Actual balance from the external statement.',
5110
+ allOf: [
5111
+ {
5112
+ $ref: '#/components/schemas/ActualBalanceDto'
5113
+ }
5114
+ ]
5115
+ }
5116
+ },
5117
+ required: ['accountId', 'asOfDate', 'actualBalance']
5118
+ } as const;
5119
+
5120
+ export const $ReconciliationComputeResultDto = {
3970
5121
  type: 'object',
3971
5122
  properties: {
3972
- secId: {
3973
- type: 'number',
3974
- description: 'Security ID'
5123
+ accountId: {
5124
+ type: 'string'
3975
5125
  },
3976
- annualInterestRate: {
3977
- type: 'number',
3978
- description: 'Annual interest rate',
3979
- example: 0.05
5126
+ asOfDate: {
5127
+ type: 'string'
3980
5128
  },
3981
- currency: {
5129
+ bookBalance: {
3982
5130
  type: 'string',
3983
- description: 'Currency code',
3984
- example: 'USD'
5131
+ description: 'System-computed book balance (decimal string).'
3985
5132
  },
3986
- baseCurrency: {
5133
+ actualBalance: {
3987
5134
  type: 'string',
3988
- description: 'Base currency code',
3989
- example: 'USD'
5135
+ description: 'User-entered actual balance (decimal string).'
3990
5136
  },
3991
- benchmark: {
3992
- type: 'string',
3993
- description: 'Benchmark symbol',
3994
- example: 'SPY'
5137
+ currency: {
5138
+ type: 'string'
3995
5139
  },
3996
- colorScheme: {
5140
+ diff: {
3997
5141
  type: 'string',
3998
- description: 'Color scheme',
3999
- enum: ['DARK', 'LIGHT']
5142
+ description: 'Diff = book − actual (decimal string).'
4000
5143
  },
4001
- dateRange: {
5144
+ tolerance: {
4002
5145
  type: 'string',
4003
- description: 'Date range filter',
4004
- example: '1y'
4005
- },
4006
- emergencyFund: {
4007
- type: 'number',
4008
- description: 'Emergency fund amount',
4009
- example: 10000
4010
- },
4011
- 'filters.accounts': {
4012
- description: 'Account filter IDs',
4013
- type: 'array',
4014
- items: {
4015
- type: 'string'
4016
- }
5146
+ description: 'Applied tolerance (decimal string).'
4017
5147
  },
4018
- 'filters.assetClasses': {
4019
- description: 'Asset class filters',
4020
- type: 'array',
4021
- items: {
4022
- type: 'string'
4023
- }
5148
+ withinTolerance: {
5149
+ type: 'boolean',
5150
+ description: 'true when |diff| ≤ tolerance.'
4024
5151
  },
4025
- 'filters.dataSource': {
5152
+ suggestedAction: {
4026
5153
  type: 'string',
4027
- description: 'Data source filter'
5154
+ enum: ['assert', 'pad'],
5155
+ description:
5156
+ 'Suggested next action: assert when within tolerance, pad otherwise.'
5157
+ }
5158
+ },
5159
+ required: [
5160
+ 'accountId',
5161
+ 'asOfDate',
5162
+ 'bookBalance',
5163
+ 'actualBalance',
5164
+ 'currency',
5165
+ 'diff',
5166
+ 'tolerance',
5167
+ 'withinTolerance',
5168
+ 'suggestedAction'
5169
+ ]
5170
+ } as const;
5171
+
5172
+ export const $AssertReconciliationDto = {
5173
+ type: 'object',
5174
+ properties: {
5175
+ accountId: {
5176
+ type: 'string',
5177
+ description: 'BeanAccount id to reconcile.'
4028
5178
  },
4029
- 'filters.symbol': {
5179
+ asOfDate: {
4030
5180
  type: 'string',
4031
- description: 'Symbol filter'
5181
+ description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
5182
+ example: '2026-07-24'
4032
5183
  },
4033
- 'filters.tags': {
4034
- description: 'Tag filters',
4035
- type: 'array',
4036
- items: {
4037
- type: 'string'
4038
- }
5184
+ actualBalance: {
5185
+ description: 'Actual balance from the external statement.',
5186
+ allOf: [
5187
+ {
5188
+ $ref: '#/components/schemas/ActualBalanceDto'
5189
+ }
5190
+ ]
4039
5191
  },
4040
- isExperimentalFeatures: {
4041
- type: 'boolean',
4042
- description: 'Enable experimental features'
5192
+ tolerance: {
5193
+ type: 'string',
5194
+ description:
5195
+ 'Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).',
5196
+ example: '0.01'
5197
+ }
5198
+ },
5199
+ required: ['accountId', 'asOfDate', 'actualBalance']
5200
+ } as const;
5201
+
5202
+ export const $ReconciliationRecordDto = {
5203
+ type: 'object',
5204
+ properties: {
5205
+ id: {
5206
+ type: 'string'
4043
5207
  },
4044
- isRestrictedView: {
4045
- type: 'boolean',
4046
- description: 'Enable restricted view mode'
5208
+ accountId: {
5209
+ type: 'string'
4047
5210
  },
4048
- language: {
5211
+ date: {
5212
+ type: 'string'
5213
+ },
5214
+ amount: {
4049
5215
  type: 'string',
4050
- description: 'Language code',
4051
- example: 'en'
5216
+ description: 'Asserted (actual) amount.'
4052
5217
  },
4053
- locale: {
5218
+ currency: {
5219
+ type: 'string'
5220
+ },
5221
+ tolerance: {
5222
+ type: 'string'
5223
+ },
5224
+ diffAmount: {
4054
5225
  type: 'string',
4055
- description: 'Locale code',
4056
- example: 'en-US'
5226
+ description: 'book − actual.'
4057
5227
  },
4058
- projectedTotalAmount: {
4059
- type: 'number',
4060
- description: 'Projected total amount',
4061
- example: 1000000
5228
+ diffCurrency: {
5229
+ type: 'string'
4062
5230
  },
4063
- retirementDate: {
5231
+ createdAt: {
5232
+ type: 'string'
5233
+ }
5234
+ },
5235
+ required: ['id', 'accountId', 'date', 'amount', 'currency', 'createdAt']
5236
+ } as const;
5237
+
5238
+ export const $PadReconciliationDto = {
5239
+ type: 'object',
5240
+ properties: {
5241
+ accountId: {
4064
5242
  type: 'string',
4065
- description: 'Retirement date in ISO 8601 format',
4066
- example: '2050-01-01'
5243
+ description: 'BeanAccount id to reconcile.'
4067
5244
  },
4068
- savingsRate: {
4069
- type: 'number',
4070
- description: 'Savings rate percentage',
4071
- example: 0.2
5245
+ asOfDate: {
5246
+ type: 'string',
5247
+ description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
5248
+ example: '2026-07-24'
4072
5249
  },
4073
- viewMode: {
5250
+ actualBalance: {
5251
+ description: 'Actual balance from the external statement.',
5252
+ allOf: [
5253
+ {
5254
+ $ref: '#/components/schemas/ActualBalanceDto'
5255
+ }
5256
+ ]
5257
+ },
5258
+ sourceAccount: {
4074
5259
  type: 'string',
4075
- description: 'View mode',
4076
- enum: ['DEFAULT', 'ZEN']
5260
+ description:
5261
+ 'Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).',
5262
+ example: 'Equity:Opening-Balances',
5263
+ default: 'Equity:Opening-Balances'
4077
5264
  }
4078
- }
5265
+ },
5266
+ required: ['accountId', 'asOfDate', 'actualBalance']
4079
5267
  } as const;
4080
5268
 
4081
- export const $UpdatePropertyDto = {
5269
+ export const $PadResultDto = {
4082
5270
  type: 'object',
4083
5271
  properties: {
4084
- value: {
5272
+ transactionId: {
4085
5273
  type: 'string',
4086
- description: 'Property value'
5274
+ description: 'Created pad adjusting transaction id.'
4087
5275
  }
4088
5276
  },
4089
- required: ['value']
5277
+ required: ['transactionId']
4090
5278
  } as const;
4091
5279
 
4092
5280
  export const $FileImportDto = {
@@ -4255,7 +5443,7 @@ export const $IdentifyResultDto = {
4255
5443
  account: {
4256
5444
  type: 'string',
4257
5445
  description: 'Default account used by this importer',
4258
- example: 'Assets:Alipay:Balance'
5446
+ example: 'Assets:CN:Alipay:Balance'
4259
5447
  },
4260
5448
  message: {
4261
5449
  type: 'string',
@@ -4272,7 +5460,7 @@ export const $MapperDefaultsDto = {
4272
5460
  sourceAccount: {
4273
5461
  type: 'string',
4274
5462
  description: 'Source account for transactions (Beancount format)',
4275
- example: 'Assets:Alipay:Balance'
5463
+ example: 'Assets:CN:Alipay:Balance'
4276
5464
  },
4277
5465
  currency: {
4278
5466
  type: 'string',
@@ -4309,7 +5497,7 @@ export const $MapperDefaultsDto = {
4309
5497
  description:
4310
5498
  '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).',
4311
5499
  example: {
4312
- HuaBei: 'Liabilities:Alipay:Huabei',
5500
+ HuaBei: 'Liabilities:CN:CreditLine',
4313
5501
  CreditCard: 'Liabilities:CreditCard'
4314
5502
  }
4315
5503
  }
@@ -4441,7 +5629,7 @@ export const $UpdateMapperDefaultsDto = {
4441
5629
  sourceAccount: {
4442
5630
  type: 'string',
4443
5631
  description: 'Source account for transactions (Beancount format)',
4444
- example: 'Assets:Alipay:Balance',
5632
+ example: 'Assets:CN:Alipay:Balance',
4445
5633
  pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
4446
5634
  },
4447
5635
  currency: {
@@ -4469,7 +5657,7 @@ export const $UpdateMapperDefaultsDto = {
4469
5657
  description:
4470
5658
  '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).',
4471
5659
  example: {
4472
- HuaBei: 'Liabilities:Alipay:Huabei',
5660
+ HuaBei: 'Liabilities:CN:CreditLine',
4473
5661
  CreditCard: 'Liabilities:CreditCard'
4474
5662
  }
4475
5663
  }
@@ -4496,116 +5684,10 @@ export const $UpdateImporterConfigDto = {
4496
5684
  data: {
4497
5685
  description: 'Configuration data (v1 schema)',
4498
5686
  allOf: [
4499
- {
4500
- $ref: '#/components/schemas/UpdateConfigDataDto'
4501
- }
4502
- ]
4503
- }
4504
- }
4505
- } as const;
4506
-
4507
- export const $CreatePlatformDto = {
4508
- type: 'object',
4509
- properties: {
4510
- name: {
4511
- type: 'string',
4512
- description: 'Platform name',
4513
- example: 'Binance'
4514
- },
4515
- canonical: {
4516
- type: 'string',
4517
- description: 'Platform canonical identifier (lowercase, kebab-case)',
4518
- example: 'binance'
4519
- },
4520
- aliases: {
4521
- description: 'Platform aliases (multi-language names for lookup)',
4522
- example: ['Binance', 'Binance Exchange', 'BNB'],
4523
- type: 'array',
4524
- items: {
4525
- type: 'string'
4526
- }
4527
- },
4528
- url: {
4529
- type: 'string',
4530
- description: 'Platform URL',
4531
- example: 'https://www.binance.com'
4532
- },
4533
- type: {
4534
- type: 'string',
4535
- description: 'Platform type',
4536
- enum: [
4537
- 'BANK',
4538
- 'BROKERAGE',
4539
- 'CRYPTO_EXCHANGE',
4540
- 'PAYMENT',
4541
- 'INVESTMENT',
4542
- 'INSURANCE',
4543
- 'OTHER'
4544
- ],
4545
- example: 'CRYPTO_EXCHANGE'
4546
- },
4547
- logoUrl: {
4548
- type: 'string',
4549
- description: 'Platform logo URL',
4550
- example: 'https://example.com/logos/binance.png'
4551
- },
4552
- isActive: {
4553
- type: 'boolean',
4554
- description: 'Whether the platform is active',
4555
- default: true
4556
- }
4557
- },
4558
- required: ['name', 'canonical', 'aliases', 'url', 'type']
4559
- } as const;
4560
-
4561
- export const $UpdatePlatformDto = {
4562
- type: 'object',
4563
- properties: {
4564
- name: {
4565
- type: 'string',
4566
- description: 'Platform name',
4567
- example: 'Binance'
4568
- },
4569
- canonical: {
4570
- type: 'string',
4571
- description: 'Platform canonical identifier (lowercase, kebab-case)',
4572
- example: 'binance'
4573
- },
4574
- aliases: {
4575
- description: 'Platform aliases (multi-language names for lookup)',
4576
- example: ['Binance', 'Binance Exchange', 'BNB'],
4577
- type: 'array',
4578
- items: {
4579
- type: 'string'
4580
- }
4581
- },
4582
- url: {
4583
- type: 'string',
4584
- description: 'Platform URL',
4585
- example: 'https://www.binance.com'
4586
- },
4587
- type: {
4588
- type: 'string',
4589
- description: 'Platform type',
4590
- enum: [
4591
- 'BANK',
4592
- 'BROKERAGE',
4593
- 'CRYPTO_EXCHANGE',
4594
- 'PAYMENT',
4595
- 'INVESTMENT',
4596
- 'INSURANCE',
4597
- 'OTHER'
4598
- ],
4599
- example: 'CRYPTO_EXCHANGE'
4600
- },
4601
- logoUrl: {
4602
- type: 'string',
4603
- description: 'Platform logo URL',
4604
- example: 'https://example.com/logos/binance.png'
4605
- },
4606
- isActive: {
4607
- type: 'boolean',
4608
- description: 'Whether the platform is active'
5687
+ {
5688
+ $ref: '#/components/schemas/UpdateConfigDataDto'
5689
+ }
5690
+ ]
4609
5691
  }
4610
5692
  }
4611
5693
  } as const;
@@ -4616,7 +5698,7 @@ export const $ProviderSyncConfigDto = {
4616
5698
  sourceAccount: {
4617
5699
  type: 'string',
4618
5700
  description: 'Source account for the first posting',
4619
- example: 'Assets:Bank:Chase'
5701
+ example: 'Assets:US:Chase:Checking'
4620
5702
  },
4621
5703
  defaultCurrency: {
4622
5704
  type: 'string',
@@ -4637,6 +5719,12 @@ export const $ProviderSyncConfigDto = {
4637
5719
  type: 'boolean',
4638
5720
  description: 'Filter pending transactions',
4639
5721
  default: true
5722
+ },
5723
+ externalAccountId: {
5724
+ type: 'string',
5725
+ description:
5726
+ 'External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.',
5727
+ example: 'acc_gocardless_001'
4640
5728
  }
4641
5729
  },
4642
5730
  required: [
@@ -4756,11 +5844,104 @@ export const $SupportedProvidersResponseDto = {
4756
5844
  required: ['providers']
4757
5845
  } as const;
4758
5846
 
5847
+ export const $CreateExternalAccountLinkDto = {
5848
+ type: 'object',
5849
+ properties: {
5850
+ provider: {
5851
+ type: 'string',
5852
+ enum: [
5853
+ 'plaid',
5854
+ 'teller',
5855
+ 'truelayer',
5856
+ 'gocardless',
5857
+ 'simplefin',
5858
+ 'yodlee',
5859
+ 'beancount-direct',
5860
+ 'parsed-bill'
5861
+ ],
5862
+ example: 'plaid',
5863
+ description: 'Open Banking provider (whitelist)'
5864
+ },
5865
+ externalAccountId: {
5866
+ type: 'string',
5867
+ example: 'acc-plaid-001',
5868
+ description: 'External account ID from the provider'
5869
+ },
5870
+ beanAccountId: {
5871
+ type: 'string',
5872
+ example: '550e8400-e29b-41d4-a716-446655440000',
5873
+ description: 'Target BeanAccount ID (must belong to the JWT user)'
5874
+ }
5875
+ },
5876
+ required: ['provider', 'externalAccountId', 'beanAccountId']
5877
+ } as const;
5878
+
5879
+ export const $ExternalAccountLinkResponseDto = {
5880
+ type: 'object',
5881
+ properties: {
5882
+ id: {
5883
+ type: 'string'
5884
+ },
5885
+ provider: {
5886
+ type: 'string'
5887
+ },
5888
+ externalAccountId: {
5889
+ type: 'string'
5890
+ },
5891
+ beanAccountId: {
5892
+ type: 'string'
5893
+ },
5894
+ isActive: {
5895
+ type: 'boolean'
5896
+ },
5897
+ createdAt: {
5898
+ type: 'string'
5899
+ },
5900
+ updatedAt: {
5901
+ type: 'string'
5902
+ }
5903
+ },
5904
+ required: [
5905
+ 'id',
5906
+ 'provider',
5907
+ 'externalAccountId',
5908
+ 'beanAccountId',
5909
+ 'isActive',
5910
+ 'createdAt',
5911
+ 'updatedAt'
5912
+ ]
5913
+ } as const;
5914
+
5915
+ export const $ExternalAccountLinkListResponseDto = {
5916
+ type: 'object',
5917
+ properties: {
5918
+ items: {
5919
+ type: 'array',
5920
+ items: {
5921
+ $ref: '#/components/schemas/ExternalAccountLinkResponseDto'
5922
+ }
5923
+ },
5924
+ total: {
5925
+ type: 'number'
5926
+ },
5927
+ provider: {
5928
+ type: 'string',
5929
+ description: 'Filter by provider (query param)'
5930
+ }
5931
+ },
5932
+ required: ['items', 'total']
5933
+ } as const;
5934
+
4759
5935
  export const $ParserTelemetryReportDto = {
4760
5936
  type: 'object',
4761
5937
  properties: {}
4762
5938
  } as const;
4763
5939
 
5940
+ export const $UncoveredFormatMissDto = {
5941
+ type: 'object',
5942
+ properties: {}
5943
+ } as const;
5944
+
4764
5945
  export const $ProcessNlpDto = {
4765
5946
  type: 'object',
4766
5947
  properties: {
@@ -4785,6 +5966,18 @@ export const $ProcessNlpDto = {
4785
5966
  currency: 'CNY',
4786
5967
  payee: 'Starbucks'
4787
5968
  }
5969
+ },
5970
+ selectedRuleId: {
5971
+ type: 'string',
5972
+ description:
5973
+ '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.',
5974
+ example: 'rule_abc123'
5975
+ },
5976
+ selectedAccount: {
5977
+ type: 'string',
5978
+ description:
5979
+ '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.',
5980
+ example: 'Expenses:Food:Coffee'
4788
5981
  }
4789
5982
  },
4790
5983
  required: ['message']
@@ -5109,7 +6302,8 @@ export const $NlpAccountConfirmationDataDto = {
5109
6302
  },
5110
6303
  suggestedAccount: {
5111
6304
  type: 'string',
5112
- description: 'Suggested replacement account',
6305
+ description:
6306
+ 'Suggested replacement account (omitted when no clear candidate)',
5113
6307
  example: 'Expenses:Food:Drinks'
5114
6308
  },
5115
6309
  similarAccounts: {
@@ -5131,7 +6325,6 @@ export const $NlpAccountConfirmationDataDto = {
5131
6325
  },
5132
6326
  required: [
5133
6327
  'invalidAccount',
5134
- 'suggestedAccount',
5135
6328
  'similarAccounts',
5136
6329
  'errorMessage',
5137
6330
  'transactionContext'
@@ -5300,11 +6493,12 @@ export const $NlpSuggestedAccountDto = {
5300
6493
  account: {
5301
6494
  type: 'string',
5302
6495
  description: 'Suggested account path',
5303
- example: 'Assets:Bank:Checking'
6496
+ example: 'Assets:Checking'
5304
6497
  },
5305
6498
  confidence: {
5306
6499
  type: 'number',
5307
- description: 'Confidence score for this suggestion (0-1)',
6500
+ description:
6501
+ 'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
5308
6502
  example: 0.9
5309
6503
  }
5310
6504
  },
@@ -5340,23 +6534,31 @@ export const $NlpDefaultAccountsDto = {
5340
6534
  properties: {
5341
6535
  asset: {
5342
6536
  type: 'string',
5343
- description: 'Default asset account',
5344
- example: 'Assets:Bank:Checking'
6537
+ description:
6538
+ 'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
6539
+ example: 'Assets:Checking',
6540
+ nullable: true
5345
6541
  },
5346
6542
  expense: {
5347
6543
  type: 'string',
5348
- description: 'Default expense account',
5349
- example: 'Expenses:Uncategorized'
6544
+ description:
6545
+ 'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
6546
+ example: 'Expenses:Food:Coffee',
6547
+ nullable: true
5350
6548
  },
5351
6549
  income: {
5352
6550
  type: 'string',
5353
- description: 'Default income account',
5354
- example: 'Income:Uncategorized'
6551
+ description:
6552
+ 'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
6553
+ example: 'Income:Salary',
6554
+ nullable: true
5355
6555
  },
5356
6556
  liability: {
5357
6557
  type: 'string',
5358
- description: 'Default liability account',
5359
- example: 'Liabilities:CreditCard'
6558
+ description:
6559
+ 'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
6560
+ example: 'Liabilities:CreditCard',
6561
+ nullable: true
5360
6562
  }
5361
6563
  },
5362
6564
  required: ['asset', 'expense', 'income', 'liability']
@@ -5381,7 +6583,8 @@ export const $NlpResponseDto = {
5381
6583
  'confirm_rule',
5382
6584
  'confirm_account',
5383
6585
  'confirm_payee',
5384
- 'cancel'
6586
+ 'cancel',
6587
+ 'aborted'
5385
6588
  ]
5386
6589
  },
5387
6590
  intent: {
@@ -5541,43 +6744,274 @@ export const $NlpResponseDto = {
5541
6744
  }
5542
6745
  ]
5543
6746
  },
5544
- suggestedAccounts: {
5545
- description:
5546
- 'Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.',
5547
- allOf: [
5548
- {
5549
- $ref: '#/components/schemas/NlpSuggestedAccountsDto'
5550
- }
5551
- ]
6747
+ suggestedAccounts: {
6748
+ description:
6749
+ '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.',
6750
+ allOf: [
6751
+ {
6752
+ $ref: '#/components/schemas/NlpSuggestedAccountsDto'
6753
+ }
6754
+ ]
6755
+ },
6756
+ defaultAccounts: {
6757
+ description:
6758
+ 'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
6759
+ allOf: [
6760
+ {
6761
+ $ref: '#/components/schemas/NlpDefaultAccountsDto'
6762
+ }
6763
+ ]
6764
+ }
6765
+ },
6766
+ required: ['status', 'action']
6767
+ } as const;
6768
+
6769
+ export const $PlatformListItemDto = {
6770
+ type: 'object',
6771
+ properties: {
6772
+ id: {
6773
+ type: 'string',
6774
+ description: 'Global platform ID'
6775
+ },
6776
+ name: {
6777
+ type: 'string',
6778
+ description: 'Platform name'
6779
+ },
6780
+ url: {
6781
+ type: 'string',
6782
+ description: 'Platform URL'
6783
+ },
6784
+ type: {
6785
+ type: 'string',
6786
+ description: 'Platform type',
6787
+ enum: [
6788
+ 'BANK',
6789
+ 'BROKERAGE',
6790
+ 'CRYPTO_EXCHANGE',
6791
+ 'PAYMENT',
6792
+ 'INVESTMENT',
6793
+ 'INSURANCE',
6794
+ 'OTHER'
6795
+ ]
6796
+ },
6797
+ canonical: {
6798
+ type: 'string',
6799
+ description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
6800
+ },
6801
+ suggestedSegment: {
6802
+ type: 'string',
6803
+ description:
6804
+ 'Suggested path segment — canonical with first char uppercased (ACC_COMP_NAME_RE)'
6805
+ },
6806
+ logoUrl: {
6807
+ type: 'string',
6808
+ description: 'Logo URL',
6809
+ nullable: true
6810
+ },
6811
+ isBound: {
6812
+ type: 'boolean',
6813
+ description: 'Whether user has accounts using this platform'
6814
+ }
6815
+ },
6816
+ required: [
6817
+ 'id',
6818
+ 'name',
6819
+ 'url',
6820
+ 'type',
6821
+ 'canonical',
6822
+ 'suggestedSegment',
6823
+ 'logoUrl',
6824
+ 'isBound'
6825
+ ]
6826
+ } as const;
6827
+
6828
+ export const $PlatformMatchResultDto = {
6829
+ type: 'object',
6830
+ properties: {
6831
+ id: {
6832
+ type: 'string',
6833
+ description: 'Global platform ID'
6834
+ },
6835
+ name: {
6836
+ type: 'string',
6837
+ description: 'Platform name (e.g., "ICBC")'
6838
+ },
6839
+ canonical: {
6840
+ type: 'string',
6841
+ description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
6842
+ },
6843
+ type: {
6844
+ type: 'string',
6845
+ description: 'Platform type',
6846
+ enum: [
6847
+ 'BANK',
6848
+ 'BROKERAGE',
6849
+ 'CRYPTO_EXCHANGE',
6850
+ 'PAYMENT',
6851
+ 'INVESTMENT',
6852
+ 'INSURANCE',
6853
+ 'OTHER'
6854
+ ]
6855
+ },
6856
+ suggestedSegment: {
6857
+ type: 'string',
6858
+ description:
6859
+ 'Suggested path segment — canonical, already in ACCOUNT_RE format'
6860
+ },
6861
+ logoUrl: {
6862
+ type: 'string',
6863
+ description: 'Logo URL',
6864
+ nullable: true
6865
+ },
6866
+ matchType: {
6867
+ type: 'string',
6868
+ description: "How this row matched: 'exact' > 'prefix' > 'substring'",
6869
+ enum: ['exact', 'prefix', 'substring']
6870
+ }
6871
+ },
6872
+ required: [
6873
+ 'id',
6874
+ 'name',
6875
+ 'canonical',
6876
+ 'type',
6877
+ 'suggestedSegment',
6878
+ 'logoUrl',
6879
+ 'matchType'
6880
+ ]
6881
+ } as const;
6882
+
6883
+ export const $PlatformMatchResponseDto = {
6884
+ type: 'object',
6885
+ properties: {
6886
+ platforms: {
6887
+ description: 'Ranked matches, best tier first (at most 10 rows)',
6888
+ type: 'array',
6889
+ items: {
6890
+ $ref: '#/components/schemas/PlatformMatchResultDto'
6891
+ }
6892
+ },
6893
+ matchType: {
6894
+ type: 'string',
6895
+ description:
6896
+ "Overall match quality — top row's tier, or 'none' when no hits",
6897
+ enum: ['none', 'exact', 'prefix', 'substring']
6898
+ },
6899
+ total: {
6900
+ type: 'number',
6901
+ description: 'Total matches before LIMIT (truncation transparency)'
6902
+ },
6903
+ hasMore: {
6904
+ type: 'boolean',
6905
+ description: 'true when total > platforms.length (more matches exist)'
6906
+ }
6907
+ },
6908
+ required: ['platforms', 'matchType', 'total', 'hasMore']
6909
+ } as const;
6910
+
6911
+ export const $CreatePlatformDto = {
6912
+ type: 'object',
6913
+ properties: {
6914
+ name: {
6915
+ type: 'string',
6916
+ description: 'Platform name',
6917
+ example: 'Binance'
6918
+ },
6919
+ canonical: {
6920
+ type: 'string',
6921
+ description: 'Platform canonical identifier (lowercase, kebab-case)',
6922
+ example: 'binance'
6923
+ },
6924
+ aliases: {
6925
+ description: 'Platform aliases (multi-language names for lookup)',
6926
+ example: ['Binance', 'Binance Exchange', 'BNB'],
6927
+ type: 'array',
6928
+ items: {
6929
+ type: 'string'
6930
+ }
6931
+ },
6932
+ url: {
6933
+ type: 'string',
6934
+ description: 'Platform URL',
6935
+ example: 'https://www.binance.com'
6936
+ },
6937
+ type: {
6938
+ type: 'string',
6939
+ description: 'Platform type',
6940
+ enum: [
6941
+ 'BANK',
6942
+ 'BROKERAGE',
6943
+ 'CRYPTO_EXCHANGE',
6944
+ 'PAYMENT',
6945
+ 'INVESTMENT',
6946
+ 'INSURANCE',
6947
+ 'OTHER'
6948
+ ],
6949
+ example: 'CRYPTO_EXCHANGE'
6950
+ },
6951
+ logoUrl: {
6952
+ type: 'string',
6953
+ description: 'Platform logo URL',
6954
+ example: 'https://example.com/logos/binance.png'
5552
6955
  },
5553
- defaultAccounts: {
5554
- description:
5555
- 'Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.',
5556
- allOf: [
5557
- {
5558
- $ref: '#/components/schemas/NlpDefaultAccountsDto'
5559
- }
5560
- ]
6956
+ isActive: {
6957
+ type: 'boolean',
6958
+ description: 'Whether the platform is active',
6959
+ default: true
5561
6960
  }
5562
6961
  },
5563
- required: ['status', 'action']
6962
+ required: ['name', 'canonical', 'aliases', 'url', 'type']
5564
6963
  } as const;
5565
6964
 
5566
- export const $BalanceByCurrencyDto = {
6965
+ export const $UpdatePlatformDto = {
5567
6966
  type: 'object',
5568
6967
  properties: {
5569
- currency: {
6968
+ name: {
5570
6969
  type: 'string',
5571
- description: 'ISO 4217 currency code',
5572
- example: 'CNY'
6970
+ description: 'Platform name',
6971
+ example: 'Binance'
5573
6972
  },
5574
- balance: {
6973
+ canonical: {
5575
6974
  type: 'string',
5576
- description: 'Balance amount',
5577
- example: '50000.00'
6975
+ description: 'Platform canonical identifier (lowercase, kebab-case)',
6976
+ example: 'binance'
6977
+ },
6978
+ aliases: {
6979
+ description: 'Platform aliases (multi-language names for lookup)',
6980
+ example: ['Binance', 'Binance Exchange', 'BNB'],
6981
+ type: 'array',
6982
+ items: {
6983
+ type: 'string'
6984
+ }
6985
+ },
6986
+ url: {
6987
+ type: 'string',
6988
+ description: 'Platform URL',
6989
+ example: 'https://www.binance.com'
6990
+ },
6991
+ type: {
6992
+ type: 'string',
6993
+ description: 'Platform type',
6994
+ enum: [
6995
+ 'BANK',
6996
+ 'BROKERAGE',
6997
+ 'CRYPTO_EXCHANGE',
6998
+ 'PAYMENT',
6999
+ 'INVESTMENT',
7000
+ 'INSURANCE',
7001
+ 'OTHER'
7002
+ ],
7003
+ example: 'CRYPTO_EXCHANGE'
7004
+ },
7005
+ logoUrl: {
7006
+ type: 'string',
7007
+ description: 'Platform logo URL',
7008
+ example: 'https://example.com/logos/binance.png'
7009
+ },
7010
+ isActive: {
7011
+ type: 'boolean',
7012
+ description: 'Whether the platform is active'
5578
7013
  }
5579
- },
5580
- required: ['currency', 'balance']
7014
+ }
5581
7015
  } as const;
5582
7016
 
5583
7017
  export const $NetWorthByCurrencyDto = {
@@ -5649,28 +7083,6 @@ export const $ConvertedNetWorthDto = {
5649
7083
  ]
5650
7084
  } as const;
5651
7085
 
5652
- export const $ExchangeRateWarningDto = {
5653
- type: 'object',
5654
- properties: {
5655
- type: {
5656
- type: 'string',
5657
- description: 'Warning type',
5658
- example: 'MISSING_EXCHANGE_RATE'
5659
- },
5660
- currency: {
5661
- type: 'string',
5662
- description: 'Currency without exchange rate',
5663
- example: 'EUR'
5664
- },
5665
- totalAmount: {
5666
- type: 'string',
5667
- description: 'Total amount affected',
5668
- example: '1000.00'
5669
- }
5670
- },
5671
- required: ['type', 'currency', 'totalAmount']
5672
- } as const;
5673
-
5674
7086
  export const $NetWorthResponseDto = {
5675
7087
  type: 'object',
5676
7088
  properties: {
@@ -5756,7 +7168,7 @@ export const $AccountItemDto = {
5756
7168
  name: {
5757
7169
  type: 'string',
5758
7170
  description: 'Full account name',
5759
- example: 'Assets:Bank:CMB:Savings'
7171
+ example: 'Assets:CN:CMB:Savings'
5760
7172
  },
5761
7173
  displayName: {
5762
7174
  type: 'string',
@@ -5772,6 +7184,12 @@ export const $AccountItemDto = {
5772
7184
  type: 'string',
5773
7185
  description: 'Currency code',
5774
7186
  example: 'CNY'
7187
+ },
7188
+ convertedBalance: {
7189
+ type: 'string',
7190
+ description:
7191
+ 'FX-converted balance in base currency; omitted when not convertible',
7192
+ example: '50000.00'
5775
7193
  }
5776
7194
  },
5777
7195
  required: ['id', 'name', 'displayName', 'balance', 'currency']
@@ -5798,11 +7216,66 @@ export const $PlatformGroupDto = {
5798
7216
  },
5799
7217
  totalBalance: {
5800
7218
  type: 'string',
5801
- description: 'Total balance across all accounts in platform',
7219
+ description: 'FX-converted total balance in base currency',
7220
+ example: '100000.00'
7221
+ },
7222
+ balanceByCurrency: {
7223
+ description: 'Raw (unconverted) balances grouped by currency',
7224
+ type: 'array',
7225
+ items: {
7226
+ $ref: '#/components/schemas/BalanceByCurrencyDto'
7227
+ }
7228
+ },
7229
+ convertedBalance: {
7230
+ type: 'string',
7231
+ description:
7232
+ 'Converted balance in base currency (omitted when no currency is convertible)',
5802
7233
  example: '100000.00'
7234
+ },
7235
+ sharePct: {
7236
+ type: 'number',
7237
+ description:
7238
+ 'Share of the grand converted total (0-100); 0 when grand total is 0',
7239
+ example: 42.5
7240
+ }
7241
+ },
7242
+ required: [
7243
+ 'platformId',
7244
+ 'platformName',
7245
+ 'accounts',
7246
+ 'totalBalance',
7247
+ 'balanceByCurrency',
7248
+ 'sharePct'
7249
+ ]
7250
+ } as const;
7251
+
7252
+ export const $AccountExchangeRateWarningDto = {
7253
+ type: 'object',
7254
+ properties: {
7255
+ type: {
7256
+ type: 'string',
7257
+ description: 'Warning type',
7258
+ example: 'MISSING_EXCHANGE_RATE'
7259
+ },
7260
+ currency: {
7261
+ type: 'string',
7262
+ description: 'Currency without exchange rate',
7263
+ example: 'USD'
7264
+ },
7265
+ accounts: {
7266
+ description: 'Affected account paths',
7267
+ type: 'array',
7268
+ items: {
7269
+ type: 'string'
7270
+ }
7271
+ },
7272
+ totalAmount: {
7273
+ type: 'string',
7274
+ description: 'Total amount in this currency',
7275
+ example: '5000.00'
5803
7276
  }
5804
7277
  },
5805
- required: ['platformId', 'platformName', 'accounts', 'totalBalance']
7278
+ required: ['type', 'currency', 'accounts', 'totalAmount']
5806
7279
  } as const;
5807
7280
 
5808
7281
  export const $AccountsSummaryDto = {
@@ -5815,9 +7288,21 @@ export const $AccountsSummaryDto = {
5815
7288
  totalPlatforms: {
5816
7289
  type: 'number',
5817
7290
  description: 'Total number of platforms'
7291
+ },
7292
+ baseCurrency: {
7293
+ type: 'string',
7294
+ description: 'Base currency for conversion',
7295
+ example: 'CNY'
7296
+ },
7297
+ warnings: {
7298
+ description: 'Per-account exchange rate warnings',
7299
+ type: 'array',
7300
+ items: {
7301
+ $ref: '#/components/schemas/AccountExchangeRateWarningDto'
7302
+ }
5818
7303
  }
5819
7304
  },
5820
- required: ['totalAccounts', 'totalPlatforms']
7305
+ required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
5821
7306
  } as const;
5822
7307
 
5823
7308
  export const $AccountsResponseDto = {
@@ -5852,7 +7337,7 @@ export const $AccountItemWithAssetClassDto = {
5852
7337
  name: {
5853
7338
  type: 'string',
5854
7339
  description: 'Full account name',
5855
- example: 'Assets:Bank:CMB:Savings'
7340
+ example: 'Assets:CN:CMB:Savings'
5856
7341
  },
5857
7342
  displayName: {
5858
7343
  type: 'string',
@@ -5869,6 +7354,12 @@ export const $AccountItemWithAssetClassDto = {
5869
7354
  description: 'Currency code',
5870
7355
  example: 'CNY'
5871
7356
  },
7357
+ convertedBalance: {
7358
+ type: 'string',
7359
+ description:
7360
+ 'FX-converted balance in base currency; omitted when not convertible',
7361
+ example: '50000.00'
7362
+ },
5872
7363
  assetClass: {
5873
7364
  type: 'string',
5874
7365
  description: 'Asset class',
@@ -5888,6 +7379,12 @@ export const $AccountItemWithAssetClassDto = {
5888
7379
  type: 'string',
5889
7380
  description: 'Risk level',
5890
7381
  example: 'LOW'
7382
+ },
7383
+ source: {
7384
+ type: 'string',
7385
+ description:
7386
+ 'ADR-0105 classification provenance (holding level always; account level only on FALLBACK)',
7387
+ enum: ['USER_META', 'FIAT_CURRENCY', 'OPENBB_MAPPING', 'FALLBACK']
5891
7388
  }
5892
7389
  },
5893
7390
  required: ['id', 'name', 'displayName', 'balance', 'currency', 'assetClass']
@@ -5942,82 +7439,154 @@ export const $AssetClassGroupDto = {
5942
7439
  required: ['assetClass', 'accounts', 'balanceByCurrency']
5943
7440
  } as const;
5944
7441
 
5945
- export const $AccountExchangeRateWarningDto = {
7442
+ export const $AssetClassSummaryDto = {
5946
7443
  type: 'object',
5947
7444
  properties: {
5948
- type: {
5949
- type: 'string',
5950
- description: 'Warning type',
5951
- example: 'MISSING_EXCHANGE_RATE'
7445
+ totalAccounts: {
7446
+ type: 'number',
7447
+ description: 'Total number of accounts'
5952
7448
  },
5953
- currency: {
7449
+ totalAssetClasses: {
7450
+ type: 'number',
7451
+ description: 'Total number of asset classes'
7452
+ },
7453
+ baseCurrency: {
5954
7454
  type: 'string',
5955
- description: 'Currency without exchange rate',
5956
- example: 'USD'
7455
+ description: 'Base currency for conversion',
7456
+ example: 'CNY'
5957
7457
  },
5958
- accounts: {
5959
- description: 'Affected account paths',
7458
+ warnings: {
7459
+ description: 'Exchange rate warnings',
5960
7460
  type: 'array',
5961
7461
  items: {
5962
- type: 'string'
7462
+ $ref: '#/components/schemas/AccountExchangeRateWarningDto'
5963
7463
  }
5964
7464
  },
5965
- totalAmount: {
5966
- type: 'string',
5967
- description: 'Total amount in this currency',
5968
- example: '5000.00'
7465
+ fallback: {
7466
+ type: 'object',
7467
+ description:
7468
+ 'ADR-0105 §4 fallback provenance stats (holding level only). valueRatio is the grey-area share of total converted value; count is the number of source=FALLBACK holdings.'
5969
7469
  }
5970
7470
  },
5971
- required: ['type', 'currency', 'accounts', 'totalAmount']
7471
+ required: ['totalAccounts', 'totalAssetClasses', 'baseCurrency']
5972
7472
  } as const;
5973
7473
 
5974
- export const $AssetClassSummaryDto = {
7474
+ export const $AssetClassAccountsResponseDto = {
5975
7475
  type: 'object',
5976
7476
  properties: {
5977
- totalAccounts: {
5978
- type: 'number',
5979
- description: 'Total number of accounts'
7477
+ groups: {
7478
+ description: 'Account groups by asset class',
7479
+ type: 'array',
7480
+ items: {
7481
+ $ref: '#/components/schemas/AssetClassGroupDto'
7482
+ }
7483
+ },
7484
+ summary: {
7485
+ description: 'Summary statistics',
7486
+ allOf: [
7487
+ {
7488
+ $ref: '#/components/schemas/AssetClassSummaryDto'
7489
+ }
7490
+ ]
7491
+ },
7492
+ uncategorized: {
7493
+ description:
7494
+ 'ADR-0105 §6 holding-level grey-area bucket (source=FALLBACK holdings peeled out of groups). Present only for groupBy=holdingAssetClass when FALLBACK holdings exist.',
7495
+ allOf: [
7496
+ {
7497
+ $ref: '#/components/schemas/AssetClassGroupDto'
7498
+ }
7499
+ ]
7500
+ }
7501
+ },
7502
+ required: ['groups', 'summary']
7503
+ } as const;
7504
+
7505
+ export const $HoldingAssetClassAccountSliceDto = {
7506
+ type: 'object',
7507
+ properties: {
7508
+ accountId: {
7509
+ type: 'string',
7510
+ description: 'Account ID'
7511
+ },
7512
+ accountPath: {
7513
+ type: 'string',
7514
+ description: 'Full account path',
7515
+ example: 'Assets:US:Fidelity:Brokerage'
7516
+ },
7517
+ accountCurrency: {
7518
+ type: 'string',
7519
+ description:
7520
+ 'Currency of the holding with the largest converted base value; undefined when no holding is convertible',
7521
+ example: 'USD'
7522
+ },
7523
+ marketValueBase: {
7524
+ type: 'string',
7525
+ description:
7526
+ "Account's market value in base currency (Σ converted holdings; grey bucket included)",
7527
+ example: '50000.00'
5980
7528
  },
5981
- totalAssetClasses: {
7529
+ shareOfTotalPct: {
5982
7530
  type: 'number',
5983
- description: 'Total number of asset classes'
7531
+ description:
7532
+ 'Share of the global total (0-100). 0 when globalTotal is zero (no NaN/Infinity).',
7533
+ example: 42.5
5984
7534
  },
5985
- baseCurrency: {
5986
- type: 'string',
5987
- description: 'Base currency for conversion',
5988
- example: 'CNY'
7535
+ groups: {
7536
+ description: 'Per-account asset-class breakdown',
7537
+ type: 'array',
7538
+ items: {
7539
+ $ref: '#/components/schemas/AssetClassGroupDto'
7540
+ }
5989
7541
  },
5990
- warnings: {
5991
- description: 'Exchange rate warnings',
7542
+ uncategorized: {
7543
+ description:
7544
+ 'Per-account grey bucket (source=FALLBACK holdings, incl. broker cash)',
7545
+ allOf: [
7546
+ {
7547
+ $ref: '#/components/schemas/AssetClassGroupDto'
7548
+ }
7549
+ ]
7550
+ },
7551
+ holdings: {
7552
+ description:
7553
+ 'Every holding row for this account (account ID in each row’s `id` field)',
5992
7554
  type: 'array',
5993
7555
  items: {
5994
- $ref: '#/components/schemas/AccountExchangeRateWarningDto'
7556
+ $ref: '#/components/schemas/AccountItemWithAssetClassDto'
5995
7557
  }
5996
7558
  }
5997
7559
  },
5998
- required: ['totalAccounts', 'totalAssetClasses', 'baseCurrency']
7560
+ required: [
7561
+ 'accountId',
7562
+ 'accountPath',
7563
+ 'marketValueBase',
7564
+ 'shareOfTotalPct',
7565
+ 'groups',
7566
+ 'holdings'
7567
+ ]
5999
7568
  } as const;
6000
7569
 
6001
- export const $AssetClassAccountsResponseDto = {
7570
+ export const $HoldingAssetClassCrossAccountResponseDto = {
6002
7571
  type: 'object',
6003
7572
  properties: {
6004
- groups: {
6005
- description: 'Account groups by asset class',
6006
- type: 'array',
6007
- items: {
6008
- $ref: '#/components/schemas/AssetClassGroupDto'
6009
- }
6010
- },
6011
- summary: {
6012
- description: 'Summary statistics',
7573
+ global: {
7574
+ description: 'Merged cross-account holding aggregation',
6013
7575
  allOf: [
6014
7576
  {
6015
- $ref: '#/components/schemas/AssetClassSummaryDto'
7577
+ $ref: '#/components/schemas/AssetClassAccountsResponseDto'
6016
7578
  }
6017
7579
  ]
7580
+ },
7581
+ byAccount: {
7582
+ description: 'Per-account slices',
7583
+ type: 'array',
7584
+ items: {
7585
+ $ref: '#/components/schemas/HoldingAssetClassAccountSliceDto'
7586
+ }
6018
7587
  }
6019
7588
  },
6020
- required: ['groups', 'summary']
7589
+ required: ['global', 'byAccount']
6021
7590
  } as const;
6022
7591
 
6023
7592
  export const $CashFlowByCurrencyDto = {
@@ -6119,207 +7688,582 @@ export const $CashFlowResponseDto = {
6119
7688
  description: 'Cash flow grouped by original currency',
6120
7689
  allOf: [
6121
7690
  {
6122
- $ref: '#/components/schemas/CashFlowByCurrencyDto'
7691
+ $ref: '#/components/schemas/CashFlowByCurrencyDto'
7692
+ }
7693
+ ]
7694
+ },
7695
+ converted: {
7696
+ description: 'Converted values in base currency',
7697
+ allOf: [
7698
+ {
7699
+ $ref: '#/components/schemas/ConvertedCashFlowDto'
7700
+ }
7701
+ ]
7702
+ },
7703
+ warnings: {
7704
+ description: 'Exchange rate warnings',
7705
+ type: 'array',
7706
+ items: {
7707
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
7708
+ }
7709
+ }
7710
+ },
7711
+ required: [
7712
+ 'period',
7713
+ 'income',
7714
+ 'expense',
7715
+ 'netSavings',
7716
+ 'savingsRate',
7717
+ 'currency'
7718
+ ]
7719
+ } as const;
7720
+
7721
+ export const $CategoryGroupDto = {
7722
+ type: 'object',
7723
+ properties: {
7724
+ category: {
7725
+ type: 'string',
7726
+ description:
7727
+ 'Functional category (account-path Group segment); regional and universal account paths merge under it',
7728
+ example: 'Food'
7729
+ },
7730
+ totalExpense: {
7731
+ type: 'string',
7732
+ description:
7733
+ 'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
7734
+ example: '1200.00'
7735
+ },
7736
+ sharePct: {
7737
+ type: 'number',
7738
+ description: 'Share of grand total (0-100); 0 when grand total is 0',
7739
+ example: 42.5
7740
+ },
7741
+ balanceByCurrency: {
7742
+ description: 'Raw (unconverted) expense per currency',
7743
+ type: 'array',
7744
+ items: {
7745
+ $ref: '#/components/schemas/BalanceByCurrencyDto'
7746
+ }
7747
+ },
7748
+ convertedBalance: {
7749
+ type: 'string',
7750
+ description:
7751
+ 'Converted total in base currency (omitted when FX missing for all currencies in this category)',
7752
+ example: '1200.00'
7753
+ }
7754
+ },
7755
+ required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
7756
+ } as const;
7757
+
7758
+ export const $ExpensesByCategorySummaryDto = {
7759
+ type: 'object',
7760
+ properties: {
7761
+ totalExpense: {
7762
+ type: 'string',
7763
+ description:
7764
+ 'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
7765
+ example: '5000.00'
7766
+ },
7767
+ categoryCount: {
7768
+ type: 'number',
7769
+ description: 'Number of categories',
7770
+ example: 8
7771
+ }
7772
+ },
7773
+ required: ['totalExpense', 'categoryCount']
7774
+ } as const;
7775
+
7776
+ export const $ExpensesByCategoryResponseDto = {
7777
+ type: 'object',
7778
+ properties: {
7779
+ period: {
7780
+ type: 'string',
7781
+ description: 'Period requested',
7782
+ example: '1m'
7783
+ },
7784
+ baseCurrency: {
7785
+ type: 'string',
7786
+ description: 'Base currency for converted values',
7787
+ example: 'CNY'
7788
+ },
7789
+ groups: {
7790
+ description:
7791
+ 'Expense groups by functional category, sorted by converted total desc',
7792
+ type: 'array',
7793
+ items: {
7794
+ $ref: '#/components/schemas/CategoryGroupDto'
7795
+ }
7796
+ },
7797
+ summary: {
7798
+ description: 'Summary statistics',
7799
+ allOf: [
7800
+ {
7801
+ $ref: '#/components/schemas/ExpensesByCategorySummaryDto'
7802
+ }
7803
+ ]
7804
+ },
7805
+ warnings: {
7806
+ description: 'Exchange rate warnings (e.g. missing rate for a currency)',
7807
+ type: 'array',
7808
+ items: {
7809
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
7810
+ }
7811
+ }
7812
+ },
7813
+ required: ['period', 'baseCurrency', 'groups', 'summary']
7814
+ } as const;
7815
+
7816
+ export const $MonetaryDto = {
7817
+ type: 'object',
7818
+ properties: {
7819
+ amount: {
7820
+ type: 'string',
7821
+ description: 'Amount (Decimal string)',
7822
+ example: '3000'
7823
+ },
7824
+ currency: {
7825
+ type: 'string',
7826
+ description: 'ISO 4217 currency',
7827
+ example: 'USD'
7828
+ },
7829
+ baseCcyEquivalent: {
7830
+ type: 'object',
7831
+ description: 'Converted to user base currency (Decimal string)',
7832
+ example: '21600',
7833
+ nullable: true
7834
+ }
7835
+ },
7836
+ required: ['amount', 'currency']
7837
+ } as const;
7838
+
7839
+ export const $CurrentPriceDto = {
7840
+ type: 'object',
7841
+ properties: {
7842
+ amount: {
7843
+ type: 'string',
7844
+ description: 'Price amount (Decimal string)',
7845
+ example: '250'
7846
+ },
7847
+ currency: {
7848
+ type: 'string',
7849
+ description: 'Price currency (ISO 4217)',
7850
+ example: 'USD'
7851
+ },
7852
+ date: {
7853
+ type: 'string',
7854
+ description: 'Price date (ISO 8601)',
7855
+ example: '2024-06-01'
7856
+ },
7857
+ source: {
7858
+ type: 'string',
7859
+ description: 'Price source',
7860
+ example: 'USER_OVERRIDE',
7861
+ enum: ['USER_OVERRIDE', 'OPENBB_EQUITY', 'OPENBB_CURRENCY']
7862
+ }
7863
+ },
7864
+ required: ['amount', 'currency', 'date', 'source']
7865
+ } as const;
7866
+
7867
+ export const $FxRateDto = {
7868
+ type: 'object',
7869
+ properties: {
7870
+ from: {
7871
+ type: 'string',
7872
+ example: 'USD'
7873
+ },
7874
+ to: {
7875
+ type: 'string',
7876
+ example: 'CNY'
7877
+ },
7878
+ rate: {
7879
+ type: 'string',
7880
+ description: 'FX rate (Decimal string)',
7881
+ example: '7.2'
7882
+ },
7883
+ date: {
7884
+ type: 'string',
7885
+ description: 'Rate date (ISO 8601)',
7886
+ example: '2024-01-15'
7887
+ }
7888
+ },
7889
+ required: ['from', 'to', 'rate', 'date']
7890
+ } as const;
7891
+
7892
+ export const $HoldingPnlRowDto = {
7893
+ type: 'object',
7894
+ properties: {
7895
+ accountId: {
7896
+ type: 'string',
7897
+ description: 'Account UUID',
7898
+ example: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
7899
+ },
7900
+ accountPath: {
7901
+ type: 'string',
7902
+ description: 'Full account path',
7903
+ example: 'Assets:US:Broker:AAPL'
7904
+ },
7905
+ accountCcy: {
7906
+ type: 'object',
7907
+ description: 'Account settlement currency (ISO 4217), from cost currency',
7908
+ nullable: true,
7909
+ example: 'USD'
7910
+ },
7911
+ brokerType: {
7912
+ type: 'object',
7913
+ description: 'Broker type derived from Platform.type',
7914
+ nullable: true,
7915
+ example: 'broker'
7916
+ },
7917
+ symbol: {
7918
+ type: 'string',
7919
+ description: 'Commodity symbol',
7920
+ example: 'AAPL'
7921
+ },
7922
+ chartToken: {
7923
+ type: 'string',
7924
+ description: 'Chart segment token (libs/common resolver)',
7925
+ example: 'equity',
7926
+ enum: ['equity', 'fund', 'bond', 'cash', 'other']
7927
+ },
7928
+ assetClass: {
7929
+ type: 'string',
7930
+ example: 'EQUITY'
7931
+ },
7932
+ assetSubClass: {
7933
+ type: 'object',
7934
+ nullable: true,
7935
+ example: 'STOCK'
7936
+ },
7937
+ units: {
7938
+ type: 'string',
7939
+ description: 'Net held units (Decimal string)',
7940
+ example: '12'
7941
+ },
7942
+ averageCostPerUnit: {
7943
+ description:
7944
+ 'Average cost per unit; null when cost currency conflicts or no cost',
7945
+ nullable: true,
7946
+ allOf: [
7947
+ {
7948
+ $ref: '#/components/schemas/MonetaryDto'
7949
+ }
7950
+ ]
7951
+ },
7952
+ costBasis: {
7953
+ description: 'Cost basis of held units',
7954
+ nullable: true,
7955
+ allOf: [
7956
+ {
7957
+ $ref: '#/components/schemas/MonetaryDto'
7958
+ }
7959
+ ]
7960
+ },
7961
+ marketValue: {
7962
+ description: 'Market value at asOf price',
7963
+ nullable: true,
7964
+ allOf: [
7965
+ {
7966
+ $ref: '#/components/schemas/MonetaryDto'
7967
+ }
7968
+ ]
7969
+ },
7970
+ currentPrice: {
7971
+ description: 'Price used for market value',
7972
+ nullable: true,
7973
+ allOf: [
7974
+ {
7975
+ $ref: '#/components/schemas/CurrentPriceDto'
7976
+ }
7977
+ ]
7978
+ },
7979
+ unrealizedPnlBase: {
7980
+ type: 'object',
7981
+ description:
7982
+ 'Unrealized P&L in base currency (Decimal string); null when any FX/price missing',
7983
+ nullable: true,
7984
+ example: '6000'
7985
+ },
7986
+ unrealizedPnlPct: {
7987
+ type: 'object',
7988
+ description: 'Unrealized P&L % (Decimal string)',
7989
+ nullable: true,
7990
+ example: '25'
7991
+ },
7992
+ costFxRate: {
7993
+ description: 'Historical FX rate applied to cost basis',
7994
+ nullable: true,
7995
+ allOf: [
7996
+ {
7997
+ $ref: '#/components/schemas/FxRateDto'
6123
7998
  }
6124
7999
  ]
6125
8000
  },
6126
- converted: {
6127
- description: 'Converted values in base currency',
8001
+ marketFxRate: {
8002
+ description: 'FX rate applied to market value',
8003
+ nullable: true,
6128
8004
  allOf: [
6129
8005
  {
6130
- $ref: '#/components/schemas/ConvertedCashFlowDto'
8006
+ $ref: '#/components/schemas/FxRateDto'
6131
8007
  }
6132
8008
  ]
6133
8009
  },
6134
- warnings: {
6135
- description: 'Exchange rate warnings',
6136
- type: 'array',
6137
- items: {
6138
- $ref: '#/components/schemas/ExchangeRateWarningDto'
6139
- }
8010
+ pctOfInvestedAssets: {
8011
+ type: 'object',
8012
+ description:
8013
+ 'Share of invested assets % (Decimal string); only for invested chartTokens',
8014
+ nullable: true,
8015
+ example: '40'
8016
+ },
8017
+ realizedPnl: {
8018
+ description:
8019
+ 'Cumulative realized P&L on sold lots (asOf-date cutoff); null when the method has no applicable sells, a sell lacks a price, or any required FX rate is missing (never-mix). When a sell spans multiple currencies (cross-currency sale), amount and currency reflect the base currency; baseCcyEquivalent is always the authoritative dual-FX figure',
8020
+ nullable: true,
8021
+ allOf: [
8022
+ {
8023
+ $ref: '#/components/schemas/MonetaryDto'
8024
+ }
8025
+ ]
6140
8026
  }
6141
8027
  },
6142
8028
  required: [
6143
- 'period',
6144
- 'income',
6145
- 'expense',
6146
- 'netSavings',
6147
- 'savingsRate',
6148
- 'currency'
8029
+ 'accountId',
8030
+ 'accountPath',
8031
+ 'symbol',
8032
+ 'chartToken',
8033
+ 'assetClass',
8034
+ 'units'
6149
8035
  ]
6150
8036
  } as const;
6151
8037
 
6152
- export const $CurrencyBalanceDto = {
8038
+ export const $HoldingPnlWarningDto = {
6153
8039
  type: 'object',
6154
8040
  properties: {
6155
- currency: {
8041
+ type: {
6156
8042
  type: 'string',
6157
- description: 'ISO 4217 currency code',
6158
- example: 'CNY'
8043
+ description: 'Warning type',
8044
+ example: 'MISSING_COST_FX_RATE',
8045
+ enum: [
8046
+ 'MISSING_COST_FX_RATE',
8047
+ 'MISSING_MARKET_FX_RATE',
8048
+ 'MISSING_SALE_PRICE',
8049
+ 'MISSING_REALIZED_FX_RATE',
8050
+ 'OVERSOLD_LOTS',
8051
+ 'NO_PRICE',
8052
+ 'MIXED_COST_CURRENCY'
8053
+ ]
6159
8054
  },
6160
- balance: {
6161
- type: 'string',
6162
- description: 'Balance amount',
6163
- example: '500000.00'
8055
+ symbol: {
8056
+ type: 'object',
8057
+ nullable: true
8058
+ },
8059
+ accountId: {
8060
+ type: 'object',
8061
+ nullable: true
8062
+ },
8063
+ currency: {
8064
+ type: 'object',
8065
+ nullable: true
6164
8066
  }
6165
8067
  },
6166
- required: ['currency', 'balance']
8068
+ required: ['type']
6167
8069
  } as const;
6168
8070
 
6169
- export const $TimeSeriesPointDto = {
8071
+ export const $HoldingPnlResponseDto = {
6170
8072
  type: 'object',
6171
8073
  properties: {
6172
- date: {
8074
+ asOfDate: {
6173
8075
  type: 'string',
6174
- description: 'Date in YYYY-MM-DD format',
6175
- example: '2024-06-15'
8076
+ example: '2026-07-08'
6176
8077
  },
6177
- value: {
8078
+ baseCurrency: {
6178
8079
  type: 'string',
6179
- description: 'Value at this date (in base currency)',
6180
- example: '500000.00'
8080
+ example: 'CNY'
6181
8081
  },
6182
- change: {
6183
- type: 'object',
6184
- description: 'Change from previous point',
6185
- example: '5000.00'
8082
+ method: {
8083
+ type: 'string',
8084
+ description:
8085
+ 'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
8086
+ enum: ['average', 'FIFO'],
8087
+ example: 'average'
6186
8088
  },
6187
- byCurrency: {
6188
- description: 'Multi-currency breakdown for this point',
8089
+ rows: {
6189
8090
  type: 'array',
6190
8091
  items: {
6191
- $ref: '#/components/schemas/CurrencyBalanceDto'
8092
+ $ref: '#/components/schemas/HoldingPnlRowDto'
8093
+ }
8094
+ },
8095
+ warnings: {
8096
+ type: 'array',
8097
+ items: {
8098
+ $ref: '#/components/schemas/HoldingPnlWarningDto'
6192
8099
  }
6193
8100
  }
6194
8101
  },
6195
- required: ['date', 'value']
8102
+ required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
6196
8103
  } as const;
6197
8104
 
6198
- export const $TrendSummaryDto = {
8105
+ export const $AnonymousLoginDto = {
6199
8106
  type: 'object',
6200
8107
  properties: {
6201
- startValue: {
6202
- type: 'string',
6203
- description: 'Value at start of period',
6204
- example: '450000.00'
6205
- },
6206
- endValue: {
6207
- type: 'string',
6208
- description: 'Value at end of period',
6209
- example: '500000.00'
6210
- },
6211
- totalChange: {
6212
- type: 'string',
6213
- description: 'Total change over period',
6214
- example: '50000.00'
6215
- },
6216
- totalChangePercentage: {
8108
+ accessToken: {
6217
8109
  type: 'string',
6218
- description: 'Total change percentage',
6219
- example: '+11.11%'
8110
+ description: 'Access token for anonymous login'
6220
8111
  }
6221
8112
  },
6222
- required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
8113
+ required: ['accessToken']
6223
8114
  } as const;
6224
8115
 
6225
- export const $MultiCurrencyPointDto = {
8116
+ export const $AnonymousLoginResponseDto = {
6226
8117
  type: 'object',
6227
8118
  properties: {
6228
- date: {
8119
+ authToken: {
6229
8120
  type: 'string',
6230
- description: 'Date in YYYY-MM-DD format',
6231
- example: '2024-06-15'
6232
- },
6233
- byCurrency: {
6234
- description: 'Balances by currency',
6235
- type: 'array',
6236
- items: {
6237
- $ref: '#/components/schemas/CurrencyBalanceDto'
6238
- }
8121
+ description: 'JWT auth token',
8122
+ example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
6239
8123
  }
6240
8124
  },
6241
- required: ['date', 'byCurrency']
8125
+ required: ['authToken']
6242
8126
  } as const;
6243
8127
 
6244
- export const $PortfolioTrendsResponseDto = {
8128
+ export const $SymbolSearchResultDto = {
6245
8129
  type: 'object',
6246
8130
  properties: {
6247
- series: {
6248
- description: 'Time series data points',
6249
- type: 'array',
6250
- items: {
6251
- $ref: '#/components/schemas/TimeSeriesPointDto'
6252
- }
8131
+ symbol: {
8132
+ type: 'string',
8133
+ example: 'AAPL'
6253
8134
  },
6254
- summary: {
6255
- description: 'Period summary',
6256
- allOf: [
6257
- {
6258
- $ref: '#/components/schemas/TrendSummaryDto'
6259
- }
6260
- ]
8135
+ name: {
8136
+ type: 'object',
8137
+ example: 'Apple Inc.',
8138
+ nullable: true
6261
8139
  },
6262
- period: {
6263
- type: 'string',
6264
- description: 'Period requested',
6265
- example: '6m'
8140
+ exchange: {
8141
+ type: 'object',
8142
+ example: 'US',
8143
+ nullable: true
6266
8144
  },
6267
- granularity: {
6268
- type: 'string',
6269
- description: 'Data granularity',
6270
- example: 'month'
8145
+ assetType: {
8146
+ type: 'object',
8147
+ description: 'OpenBB asset_type (e.g. stock, etf)',
8148
+ example: 'stock',
8149
+ nullable: true
6271
8150
  },
6272
- currency: {
6273
- type: 'string',
6274
- description: 'Base currency for converted values',
6275
- example: 'CNY'
8151
+ assetClass: {
8152
+ type: 'object',
8153
+ description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
8154
+ example: 'EQUITY',
8155
+ nullable: true
6276
8156
  },
6277
- byCurrency: {
6278
- description:
6279
- 'Multi-currency time series (each point has currency breakdown)',
6280
- type: 'array',
6281
- items: {
6282
- $ref: '#/components/schemas/MultiCurrencyPointDto'
6283
- }
8157
+ assetSubClass: {
8158
+ type: 'object',
8159
+ description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
8160
+ example: 'STOCK',
8161
+ nullable: true
6284
8162
  },
6285
- warnings: {
6286
- description: 'Exchange rate warnings',
6287
- type: 'array',
6288
- items: {
6289
- $ref: '#/components/schemas/ExchangeRateWarningDto'
6290
- }
8163
+ currency: {
8164
+ type: 'object',
8165
+ description: 'Trading currency (extra_data or inferred from exchange)',
8166
+ example: 'USD',
8167
+ nullable: true
6291
8168
  }
6292
8169
  },
6293
- required: ['series', 'summary', 'period', 'granularity', 'currency']
6294
- } as const;
6295
-
6296
- export const $GenerateSnapshotBody = {
6297
- type: 'object',
6298
- properties: {}
6299
- } as const;
6300
-
6301
- export const $GenerateSnapshotResponse = {
6302
- type: 'object',
6303
- properties: {}
6304
- } as const;
6305
-
6306
- export const $BackfillSnapshotsBody = {
6307
- type: 'object',
6308
- properties: {}
6309
- } as const;
6310
-
6311
- export const $BackfillSnapshotsResponse = {
6312
- type: 'object',
6313
- properties: {}
8170
+ required: ['symbol']
6314
8171
  } as const;
6315
8172
 
6316
- export const $AnonymousLoginDto = {
8173
+ export const $SymbolQuoteDto = {
6317
8174
  type: 'object',
6318
8175
  properties: {
6319
- accessToken: {
8176
+ symbol: {
6320
8177
  type: 'string',
6321
- description: 'Access token for anonymous login'
8178
+ example: 'AAPL'
8179
+ },
8180
+ name: {
8181
+ type: 'object',
8182
+ example: 'Apple Inc.',
8183
+ nullable: true
8184
+ },
8185
+ exchange: {
8186
+ type: 'object',
8187
+ example: 'US',
8188
+ nullable: true
8189
+ },
8190
+ assetType: {
8191
+ type: 'object',
8192
+ description: 'OpenBB asset_type',
8193
+ example: 'stock',
8194
+ nullable: true
8195
+ },
8196
+ assetClass: {
8197
+ type: 'object',
8198
+ description: 'IGN asset class',
8199
+ example: 'EQUITY',
8200
+ nullable: true
8201
+ },
8202
+ assetSubClass: {
8203
+ type: 'object',
8204
+ description: 'IGN asset sub-class',
8205
+ example: 'STOCK',
8206
+ nullable: true
8207
+ },
8208
+ currency: {
8209
+ type: 'object',
8210
+ description: 'Trading currency (extra_data or inferred from exchange)',
8211
+ example: 'USD',
8212
+ nullable: true
8213
+ },
8214
+ price: {
8215
+ type: 'object',
8216
+ description: 'Latest price (Decimal string)',
8217
+ example: '189.84',
8218
+ nullable: true
8219
+ },
8220
+ priceDate: {
8221
+ type: 'object',
8222
+ description: 'Date the price was observed (ISO yyyy-MM-dd)',
8223
+ example: '2026-08-05',
8224
+ nullable: true
8225
+ },
8226
+ changePercent: {
8227
+ type: 'object',
8228
+ description:
8229
+ '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.',
8230
+ example: 1.7,
8231
+ nullable: true
8232
+ },
8233
+ prevClose: {
8234
+ type: 'object',
8235
+ description: 'Previous close (Decimal string)',
8236
+ nullable: true
8237
+ },
8238
+ open: {
8239
+ type: 'object',
8240
+ description: 'Day open (Decimal string)',
8241
+ nullable: true
8242
+ },
8243
+ high: {
8244
+ type: 'object',
8245
+ description: 'Day high (Decimal string)',
8246
+ nullable: true
8247
+ },
8248
+ low: {
8249
+ type: 'object',
8250
+ description: 'Day low (Decimal string)',
8251
+ nullable: true
8252
+ },
8253
+ volume: {
8254
+ type: 'object',
8255
+ description: 'Day volume (Decimal string)',
8256
+ nullable: true
8257
+ },
8258
+ yearHigh: {
8259
+ type: 'object',
8260
+ description: '52-week high (Decimal string)',
8261
+ nullable: true
8262
+ },
8263
+ yearLow: {
8264
+ type: 'object',
8265
+ description: '52-week low (Decimal string)',
8266
+ nullable: true
6322
8267
  }
6323
- },
6324
- required: ['accessToken']
8268
+ }
6325
8269
  } as const;