@firela/api-types 0.0.0-canary.fde3e981 → 0.0.0-canary.feeae929
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +4080 -2799
- package/dist/index.d.ts +4080 -2799
- package/dist/index.js +33 -5
- package/dist/index.mjs +33 -5
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +2374 -1129
- package/src/generated/services.gen.ts +1340 -748
- package/src/generated/types.gen.ts +7249 -3142
|
@@ -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:
|
|
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:
|
|
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
|
-
|
|
54
|
+
openDirectiveMeta: {
|
|
66
55
|
type: 'object',
|
|
67
|
-
description:
|
|
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'
|
|
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:
|
|
94
|
-
},
|
|
95
|
-
displayName: {
|
|
96
|
-
type: 'string',
|
|
97
|
-
description:
|
|
98
|
-
'Display name distinguishing multiple accounts at the same path',
|
|
99
|
-
example: '工资卡'
|
|
83
|
+
example: 'Assets:CN:ICBC:Checking'
|
|
100
84
|
},
|
|
101
85
|
type: {
|
|
102
86
|
type: 'string',
|
|
@@ -104,6 +88,49 @@ export const $AccountResponseDto = {
|
|
|
104
88
|
enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
|
|
105
89
|
example: 'Assets'
|
|
106
90
|
},
|
|
91
|
+
assetSubClass: {
|
|
92
|
+
type: 'string',
|
|
93
|
+
description:
|
|
94
|
+
'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
|
|
95
|
+
enum: [
|
|
96
|
+
'DEPOSIT',
|
|
97
|
+
'CASH',
|
|
98
|
+
'MONEY_MARKET_FUND',
|
|
99
|
+
'STOCK',
|
|
100
|
+
'ETF',
|
|
101
|
+
'MUTUAL_FUND',
|
|
102
|
+
'EQUITY_COMPENSATION',
|
|
103
|
+
'GOVERNMENT_BOND',
|
|
104
|
+
'CORPORATE_BOND',
|
|
105
|
+
'BOND_FUND',
|
|
106
|
+
'PRIMARY_RESIDENCE',
|
|
107
|
+
'INVESTMENT_PROPERTY',
|
|
108
|
+
'REIT',
|
|
109
|
+
'GOLD',
|
|
110
|
+
'SILVER',
|
|
111
|
+
'PRECIOUS_METAL',
|
|
112
|
+
'PRECIOUS_METAL_FUND',
|
|
113
|
+
'COMMODITY',
|
|
114
|
+
'COMMODITY_FUND',
|
|
115
|
+
'CRYPTOCURRENCY',
|
|
116
|
+
'RETIREMENT_ACCOUNT',
|
|
117
|
+
'HEALTH_ACCOUNT',
|
|
118
|
+
'EDUCATION_ACCOUNT',
|
|
119
|
+
'INSURANCE',
|
|
120
|
+
'PRIVATE_EQUITY',
|
|
121
|
+
'HEDGE_FUND',
|
|
122
|
+
'COLLECTIBLES',
|
|
123
|
+
'MORTGAGE',
|
|
124
|
+
'STUDENT_LOAN',
|
|
125
|
+
'CREDIT_CARD',
|
|
126
|
+
'PERSONAL_LOAN',
|
|
127
|
+
'ACCOUNTS_PAYABLE',
|
|
128
|
+
'TAX_PAYABLE',
|
|
129
|
+
'OTHER'
|
|
130
|
+
],
|
|
131
|
+
nullable: true,
|
|
132
|
+
example: 'STOCK'
|
|
133
|
+
},
|
|
107
134
|
status: {
|
|
108
135
|
type: 'string',
|
|
109
136
|
description: 'Account status',
|
|
@@ -145,26 +172,26 @@ export const $AccountResponseDto = {
|
|
|
145
172
|
templatePath: {
|
|
146
173
|
type: 'string',
|
|
147
174
|
description: 'Template path reference',
|
|
148
|
-
example: 'Assets:CN:
|
|
175
|
+
example: 'Assets:CN:Checking'
|
|
149
176
|
},
|
|
150
177
|
isCustom: {
|
|
151
178
|
type: 'boolean',
|
|
152
179
|
description: 'Whether this is a custom (user-created) account',
|
|
153
180
|
example: false
|
|
154
181
|
},
|
|
155
|
-
|
|
182
|
+
displayName: {
|
|
156
183
|
type: 'string',
|
|
157
|
-
description: '
|
|
158
|
-
example: '
|
|
184
|
+
description: 'Localized display name (ADR-0114, read-time projection)',
|
|
185
|
+
example: 'Checking'
|
|
159
186
|
},
|
|
160
187
|
icon: {
|
|
161
188
|
type: 'string',
|
|
162
189
|
description: 'Icon identifier',
|
|
163
190
|
example: 'bank-icbc'
|
|
164
191
|
},
|
|
165
|
-
|
|
192
|
+
openDirectiveMeta: {
|
|
166
193
|
type: 'object',
|
|
167
|
-
description: '
|
|
194
|
+
description: 'Open directive metadata (ADR-0115 Decision 9)',
|
|
168
195
|
example: {
|
|
169
196
|
branch: 'Downtown'
|
|
170
197
|
}
|
|
@@ -192,7 +219,6 @@ export const $AccountResponseDto = {
|
|
|
192
219
|
required: [
|
|
193
220
|
'id',
|
|
194
221
|
'path',
|
|
195
|
-
'displayName',
|
|
196
222
|
'type',
|
|
197
223
|
'status',
|
|
198
224
|
'openDate',
|
|
@@ -225,11 +251,6 @@ export const $AccountListResponseDto = {
|
|
|
225
251
|
export const $UpdateAccountDto = {
|
|
226
252
|
type: 'object',
|
|
227
253
|
properties: {
|
|
228
|
-
displayName: {
|
|
229
|
-
type: 'string',
|
|
230
|
-
description: 'Display name to distinguish accounts at the same path',
|
|
231
|
-
example: '招行工资卡'
|
|
232
|
-
},
|
|
233
254
|
currencies: {
|
|
234
255
|
description: 'Allowed currencies (null = no restriction)',
|
|
235
256
|
example: ['CNY', 'USD'],
|
|
@@ -251,19 +272,15 @@ export const $UpdateAccountDto = {
|
|
|
251
272
|
'NONE'
|
|
252
273
|
]
|
|
253
274
|
},
|
|
254
|
-
i18nKey: {
|
|
255
|
-
type: 'string',
|
|
256
|
-
description: 'i18n key for display name',
|
|
257
|
-
example: 'account.custom.mybank'
|
|
258
|
-
},
|
|
259
275
|
icon: {
|
|
260
276
|
type: 'string',
|
|
261
277
|
description: 'Icon identifier',
|
|
262
278
|
example: 'bank-custom'
|
|
263
279
|
},
|
|
264
|
-
|
|
280
|
+
openDirectiveMeta: {
|
|
265
281
|
type: 'object',
|
|
266
|
-
description:
|
|
282
|
+
description:
|
|
283
|
+
'Open directive metadata (merged with existing; NOT an opening-balance amount)',
|
|
267
284
|
example: {
|
|
268
285
|
branch: 'Uptown'
|
|
269
286
|
}
|
|
@@ -310,13 +327,47 @@ export const $ReopenAccountDto = {
|
|
|
310
327
|
}
|
|
311
328
|
} as const;
|
|
312
329
|
|
|
330
|
+
export const $CreateOpeningBalanceDto = {
|
|
331
|
+
type: 'object',
|
|
332
|
+
properties: {
|
|
333
|
+
amount: {
|
|
334
|
+
type: 'number',
|
|
335
|
+
description: 'Opening balance amount (non-negative)',
|
|
336
|
+
example: 1000
|
|
337
|
+
},
|
|
338
|
+
currency: {
|
|
339
|
+
type: 'string',
|
|
340
|
+
description: 'Currency code',
|
|
341
|
+
example: 'CNY'
|
|
342
|
+
},
|
|
343
|
+
date: {
|
|
344
|
+
format: 'date-time',
|
|
345
|
+
type: 'string',
|
|
346
|
+
description: 'Opening-balance date (defaults to now)',
|
|
347
|
+
example: '2024-01-01'
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
required: ['amount', 'currency']
|
|
351
|
+
} as const;
|
|
352
|
+
|
|
353
|
+
export const $OpeningBalanceResultDto = {
|
|
354
|
+
type: 'object',
|
|
355
|
+
properties: {
|
|
356
|
+
transactionId: {
|
|
357
|
+
type: 'string',
|
|
358
|
+
description: 'Created opening-balance transaction id.'
|
|
359
|
+
}
|
|
360
|
+
},
|
|
361
|
+
required: ['transactionId']
|
|
362
|
+
} as const;
|
|
363
|
+
|
|
313
364
|
export const $AccountStandardResponseDto = {
|
|
314
365
|
type: 'object',
|
|
315
366
|
properties: {
|
|
316
367
|
path: {
|
|
317
368
|
type: 'string',
|
|
318
369
|
description: 'Account path (hierarchical, colon-separated)',
|
|
319
|
-
example: 'Assets:CN:
|
|
370
|
+
example: 'Assets:CN:Checking'
|
|
320
371
|
},
|
|
321
372
|
type: {
|
|
322
373
|
type: 'string',
|
|
@@ -324,11 +375,6 @@ export const $AccountStandardResponseDto = {
|
|
|
324
375
|
enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
|
|
325
376
|
example: 'Assets'
|
|
326
377
|
},
|
|
327
|
-
i18nKey: {
|
|
328
|
-
type: 'string',
|
|
329
|
-
description: 'i18n key for localized display name',
|
|
330
|
-
example: 'account.assets.cn.bank.icbc.checking'
|
|
331
|
-
},
|
|
332
378
|
name: {
|
|
333
379
|
type: 'string',
|
|
334
380
|
description: 'Short localized display name',
|
|
@@ -351,9 +397,47 @@ export const $AccountStandardResponseDto = {
|
|
|
351
397
|
type: 'string',
|
|
352
398
|
description: 'Icon identifier for UI display',
|
|
353
399
|
example: 'bank-icbc'
|
|
400
|
+
},
|
|
401
|
+
productCategory: {
|
|
402
|
+
type: 'string',
|
|
403
|
+
description:
|
|
404
|
+
'Onboarding product category (coarse grouping derived from assetSubClass)',
|
|
405
|
+
enum: [
|
|
406
|
+
'cash',
|
|
407
|
+
'investment',
|
|
408
|
+
'credit_card',
|
|
409
|
+
'loan',
|
|
410
|
+
'payable_tax',
|
|
411
|
+
'other'
|
|
412
|
+
],
|
|
413
|
+
example: 'investment'
|
|
414
|
+
},
|
|
415
|
+
assetClass: {
|
|
416
|
+
type: 'string',
|
|
417
|
+
description:
|
|
418
|
+
'Asset class (LIQUIDITY/EQUITY/.../LIABILITY), derived at read time from classification rules',
|
|
419
|
+
enum: [
|
|
420
|
+
'LIQUIDITY',
|
|
421
|
+
'EQUITY',
|
|
422
|
+
'FIXED_INCOME',
|
|
423
|
+
'PRECIOUS_METALS',
|
|
424
|
+
'COMMODITY',
|
|
425
|
+
'INSURANCE',
|
|
426
|
+
'ALTERNATIVE_INVESTMENT',
|
|
427
|
+
'PERSONAL_ASSETS',
|
|
428
|
+
'LIABILITY',
|
|
429
|
+
'REAL_ESTATE',
|
|
430
|
+
'INDEX'
|
|
431
|
+
]
|
|
432
|
+
},
|
|
433
|
+
assetSubClass: {
|
|
434
|
+
type: 'string',
|
|
435
|
+
description:
|
|
436
|
+
'Asset sub-class (product type, derived at read time from classification rules)',
|
|
437
|
+
example: 'STOCK'
|
|
354
438
|
}
|
|
355
439
|
},
|
|
356
|
-
required: ['path', 'type', '
|
|
440
|
+
required: ['path', 'type', 'description', 'tags', 'icon', 'productCategory']
|
|
357
441
|
} as const;
|
|
358
442
|
|
|
359
443
|
export const $AccountStandardListResponseDto = {
|
|
@@ -383,18 +467,13 @@ export const $AccountStandardListResponseDto = {
|
|
|
383
467
|
export const $TemplateMetadataDto = {
|
|
384
468
|
type: 'object',
|
|
385
469
|
properties: {
|
|
386
|
-
extendable: {
|
|
387
|
-
type: 'boolean',
|
|
388
|
-
description: 'Whether this path can be extended',
|
|
389
|
-
example: true
|
|
390
|
-
},
|
|
391
470
|
rootType: {
|
|
392
471
|
type: 'string',
|
|
393
472
|
description: 'Root account type',
|
|
394
473
|
example: 'Assets'
|
|
395
474
|
}
|
|
396
475
|
},
|
|
397
|
-
required: ['
|
|
476
|
+
required: ['rootType']
|
|
398
477
|
} as const;
|
|
399
478
|
|
|
400
479
|
export const $TemplateMetadataResponseDto = {
|
|
@@ -533,7 +612,7 @@ export const $CreatePostingDto = {
|
|
|
533
612
|
type: 'string',
|
|
534
613
|
description:
|
|
535
614
|
'Account name in Beancount format (must start with uppercase, colon-separated)',
|
|
536
|
-
example: 'Assets:
|
|
615
|
+
example: 'Assets:Checking'
|
|
537
616
|
},
|
|
538
617
|
units: {
|
|
539
618
|
type: 'string',
|
|
@@ -660,13 +739,39 @@ export const $CreateTransactionDto = {
|
|
|
660
739
|
required: ['date', 'narration', 'postings']
|
|
661
740
|
} as const;
|
|
662
741
|
|
|
742
|
+
export const $CostDetailDto = {
|
|
743
|
+
type: 'object',
|
|
744
|
+
properties: {
|
|
745
|
+
number: {
|
|
746
|
+
type: 'string',
|
|
747
|
+
description: 'Per-unit cost basis (mirrors engine Cost.number)',
|
|
748
|
+
example: '240'
|
|
749
|
+
},
|
|
750
|
+
currency: {
|
|
751
|
+
type: 'string',
|
|
752
|
+
description: 'Cost currency',
|
|
753
|
+
example: 'USD'
|
|
754
|
+
},
|
|
755
|
+
date: {
|
|
756
|
+
type: 'string',
|
|
757
|
+
description: 'Lot acquisition date (ISO yyyy-mm-dd)',
|
|
758
|
+
example: '2024-01-15'
|
|
759
|
+
},
|
|
760
|
+
label: {
|
|
761
|
+
type: 'string',
|
|
762
|
+
description: 'Lot label',
|
|
763
|
+
example: 'lot-2024-01'
|
|
764
|
+
}
|
|
765
|
+
}
|
|
766
|
+
} as const;
|
|
767
|
+
|
|
663
768
|
export const $PostingResponseDto = {
|
|
664
769
|
type: 'object',
|
|
665
770
|
properties: {
|
|
666
771
|
account: {
|
|
667
772
|
type: 'string',
|
|
668
773
|
description: 'Account name',
|
|
669
|
-
example: 'Assets:
|
|
774
|
+
example: 'Assets:Checking'
|
|
670
775
|
},
|
|
671
776
|
units: {
|
|
672
777
|
type: 'string',
|
|
@@ -678,6 +783,15 @@ export const $PostingResponseDto = {
|
|
|
678
783
|
type: 'string',
|
|
679
784
|
description: 'Currency',
|
|
680
785
|
example: 'USD'
|
|
786
|
+
},
|
|
787
|
+
cost: {
|
|
788
|
+
description:
|
|
789
|
+
'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
|
|
790
|
+
allOf: [
|
|
791
|
+
{
|
|
792
|
+
$ref: '#/components/schemas/CostDetailDto'
|
|
793
|
+
}
|
|
794
|
+
]
|
|
681
795
|
}
|
|
682
796
|
},
|
|
683
797
|
required: ['account']
|
|
@@ -1023,7 +1137,7 @@ export const $PostingDetailDto = {
|
|
|
1023
1137
|
account: {
|
|
1024
1138
|
type: 'string',
|
|
1025
1139
|
description: 'Fully-qualified Beancount account path',
|
|
1026
|
-
example: 'Assets:
|
|
1140
|
+
example: 'Assets:Checking'
|
|
1027
1141
|
},
|
|
1028
1142
|
units: {
|
|
1029
1143
|
type: 'string',
|
|
@@ -1051,6 +1165,15 @@ export const $PostingDetailDto = {
|
|
|
1051
1165
|
description: 'Cost date',
|
|
1052
1166
|
example: '2024-01-15'
|
|
1053
1167
|
},
|
|
1168
|
+
cost: {
|
|
1169
|
+
description:
|
|
1170
|
+
'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
|
|
1171
|
+
allOf: [
|
|
1172
|
+
{
|
|
1173
|
+
$ref: '#/components/schemas/CostDetailDto'
|
|
1174
|
+
}
|
|
1175
|
+
]
|
|
1176
|
+
},
|
|
1054
1177
|
priceAmount: {
|
|
1055
1178
|
type: 'string',
|
|
1056
1179
|
description: 'Price amount',
|
|
@@ -1203,6 +1326,77 @@ export const $TransactionDetailDto = {
|
|
|
1203
1326
|
]
|
|
1204
1327
|
} as const;
|
|
1205
1328
|
|
|
1329
|
+
export const $BalanceByCurrencyDto = {
|
|
1330
|
+
type: 'object',
|
|
1331
|
+
properties: {
|
|
1332
|
+
currency: {
|
|
1333
|
+
type: 'string',
|
|
1334
|
+
description: 'ISO 4217 currency code',
|
|
1335
|
+
example: 'CNY'
|
|
1336
|
+
},
|
|
1337
|
+
balance: {
|
|
1338
|
+
type: 'string',
|
|
1339
|
+
description: 'Balance amount',
|
|
1340
|
+
example: '50000.00'
|
|
1341
|
+
}
|
|
1342
|
+
},
|
|
1343
|
+
required: ['currency', 'balance']
|
|
1344
|
+
} as const;
|
|
1345
|
+
|
|
1346
|
+
export const $ExchangeRateWarningDto = {
|
|
1347
|
+
type: 'object',
|
|
1348
|
+
properties: {
|
|
1349
|
+
type: {
|
|
1350
|
+
type: 'string',
|
|
1351
|
+
description: 'Warning type',
|
|
1352
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
1353
|
+
},
|
|
1354
|
+
currency: {
|
|
1355
|
+
type: 'string',
|
|
1356
|
+
description: 'Currency without exchange rate',
|
|
1357
|
+
example: 'EUR'
|
|
1358
|
+
},
|
|
1359
|
+
totalAmount: {
|
|
1360
|
+
type: 'string',
|
|
1361
|
+
description: 'Total amount affected',
|
|
1362
|
+
example: '1000.00'
|
|
1363
|
+
}
|
|
1364
|
+
},
|
|
1365
|
+
required: ['type', 'currency', 'totalAmount']
|
|
1366
|
+
} as const;
|
|
1367
|
+
|
|
1368
|
+
export const $TransactionListSummaryDto = {
|
|
1369
|
+
type: 'object',
|
|
1370
|
+
properties: {
|
|
1371
|
+
totalAmount: {
|
|
1372
|
+
type: 'string',
|
|
1373
|
+
description:
|
|
1374
|
+
'Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.',
|
|
1375
|
+
example: '-6000.00'
|
|
1376
|
+
},
|
|
1377
|
+
currency: {
|
|
1378
|
+
type: 'string',
|
|
1379
|
+
description: 'Base currency (ISO 4217)',
|
|
1380
|
+
example: 'CNY'
|
|
1381
|
+
},
|
|
1382
|
+
balanceByCurrency: {
|
|
1383
|
+
description: 'Raw (unconverted) balance per currency',
|
|
1384
|
+
type: 'array',
|
|
1385
|
+
items: {
|
|
1386
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
1387
|
+
}
|
|
1388
|
+
},
|
|
1389
|
+
warnings: {
|
|
1390
|
+
description: 'Currencies missing an FX rate (omitted when empty)',
|
|
1391
|
+
type: 'array',
|
|
1392
|
+
items: {
|
|
1393
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
1394
|
+
}
|
|
1395
|
+
}
|
|
1396
|
+
},
|
|
1397
|
+
required: ['totalAmount', 'currency', 'balanceByCurrency']
|
|
1398
|
+
} as const;
|
|
1399
|
+
|
|
1206
1400
|
export const $TransactionListResponseDto = {
|
|
1207
1401
|
type: 'object',
|
|
1208
1402
|
properties: {
|
|
@@ -1227,6 +1421,15 @@ export const $TransactionListResponseDto = {
|
|
|
1227
1421
|
type: 'number',
|
|
1228
1422
|
description: 'Number of items skipped',
|
|
1229
1423
|
example: 0
|
|
1424
|
+
},
|
|
1425
|
+
summary: {
|
|
1426
|
+
description:
|
|
1427
|
+
'Amount summary for the full filtered set (#514). Present only when the request has a single account OR category viewpoint; omitted for search-only / plain-list / dual-perspective requests.',
|
|
1428
|
+
allOf: [
|
|
1429
|
+
{
|
|
1430
|
+
$ref: '#/components/schemas/TransactionListSummaryDto'
|
|
1431
|
+
}
|
|
1432
|
+
]
|
|
1230
1433
|
}
|
|
1231
1434
|
},
|
|
1232
1435
|
required: ['data', 'total', 'limit', 'offset']
|
|
@@ -1326,7 +1529,7 @@ export const $BalanceResponseDto = {
|
|
|
1326
1529
|
account: {
|
|
1327
1530
|
type: 'string',
|
|
1328
1531
|
description: 'Account name',
|
|
1329
|
-
example: 'Assets:
|
|
1532
|
+
example: 'Assets:Checking'
|
|
1330
1533
|
},
|
|
1331
1534
|
balance: {
|
|
1332
1535
|
type: 'string',
|
|
@@ -1353,7 +1556,7 @@ export const $MultiCurrencyBalanceResponseDto = {
|
|
|
1353
1556
|
account: {
|
|
1354
1557
|
type: 'string',
|
|
1355
1558
|
description: 'Account name',
|
|
1356
|
-
example: 'Assets:
|
|
1559
|
+
example: 'Assets:Checking'
|
|
1357
1560
|
},
|
|
1358
1561
|
balances: {
|
|
1359
1562
|
type: 'object',
|
|
@@ -1409,7 +1612,7 @@ export const $TransactionSummaryDto = {
|
|
|
1409
1612
|
accountName: {
|
|
1410
1613
|
type: 'string',
|
|
1411
1614
|
description: 'Source account name (first posting)',
|
|
1412
|
-
example: 'Assets:
|
|
1615
|
+
example: 'Assets:Checking'
|
|
1413
1616
|
},
|
|
1414
1617
|
sourceType: {
|
|
1415
1618
|
type: 'string',
|
|
@@ -1811,7 +2014,8 @@ export const $ResolveResultDto = {
|
|
|
1811
2014
|
},
|
|
1812
2015
|
resolutionId: {
|
|
1813
2016
|
type: 'string',
|
|
1814
|
-
description:
|
|
2017
|
+
description:
|
|
2018
|
+
'Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).'
|
|
1815
2019
|
},
|
|
1816
2020
|
canUndo: {
|
|
1817
2021
|
type: 'boolean',
|
|
@@ -1829,7 +2033,7 @@ export const $ResolveResultDto = {
|
|
|
1829
2033
|
example: 'rule_01HXK5V8N2M3P4Q5R6S7T8U9V0'
|
|
1830
2034
|
}
|
|
1831
2035
|
},
|
|
1832
|
-
required: ['success'
|
|
2036
|
+
required: ['success']
|
|
1833
2037
|
} as const;
|
|
1834
2038
|
|
|
1835
2039
|
export const $UndoResultDto = {
|
|
@@ -2700,56 +2904,213 @@ export const $UpdateCommodityDto = {
|
|
|
2700
2904
|
}
|
|
2701
2905
|
} as const;
|
|
2702
2906
|
|
|
2703
|
-
export const $
|
|
2907
|
+
export const $CreateBeanPriceDto = {
|
|
2704
2908
|
type: 'object',
|
|
2705
2909
|
properties: {
|
|
2706
|
-
|
|
2707
|
-
type: 'string',
|
|
2708
|
-
description: 'Rule name (unique per user)',
|
|
2709
|
-
maxLength: 100
|
|
2710
|
-
},
|
|
2711
|
-
icon: {
|
|
2910
|
+
currency: {
|
|
2712
2911
|
type: 'string',
|
|
2713
|
-
description: '
|
|
2714
|
-
|
|
2912
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
2913
|
+
example: 'USD'
|
|
2715
2914
|
},
|
|
2716
|
-
|
|
2915
|
+
quoteCurrency: {
|
|
2717
2916
|
type: 'string',
|
|
2718
|
-
description: '
|
|
2719
|
-
|
|
2720
|
-
'WEEKLY',
|
|
2721
|
-
'BIWEEKLY',
|
|
2722
|
-
'MONTHLY',
|
|
2723
|
-
'BIMONTHLY',
|
|
2724
|
-
'QUARTERLY',
|
|
2725
|
-
'YEARLY',
|
|
2726
|
-
'CUSTOM'
|
|
2727
|
-
]
|
|
2917
|
+
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
2918
|
+
example: 'CNY'
|
|
2728
2919
|
},
|
|
2729
|
-
|
|
2920
|
+
amount: {
|
|
2730
2921
|
type: 'number',
|
|
2731
|
-
description:
|
|
2922
|
+
description:
|
|
2923
|
+
'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
|
|
2924
|
+
example: 175.5,
|
|
2732
2925
|
minimum: 0
|
|
2733
2926
|
},
|
|
2734
|
-
|
|
2735
|
-
type: 'number',
|
|
2736
|
-
description: 'Expected day of month (1-31)',
|
|
2737
|
-
minimum: 1,
|
|
2738
|
-
maximum: 31
|
|
2739
|
-
},
|
|
2740
|
-
customIntervalDays: {
|
|
2741
|
-
type: 'number',
|
|
2742
|
-
description: 'Custom interval in days (required for CUSTOM frequency)',
|
|
2743
|
-
minimum: 1
|
|
2744
|
-
},
|
|
2745
|
-
currency: {
|
|
2927
|
+
date: {
|
|
2746
2928
|
type: 'string',
|
|
2747
|
-
description: '
|
|
2748
|
-
|
|
2749
|
-
maxLength: 10
|
|
2929
|
+
description: 'Price date (ISO 8601 format)',
|
|
2930
|
+
example: '2024-11-05'
|
|
2750
2931
|
},
|
|
2751
|
-
|
|
2752
|
-
type: '
|
|
2932
|
+
metadata: {
|
|
2933
|
+
type: 'object',
|
|
2934
|
+
description:
|
|
2935
|
+
'Metadata (validated by Zod schema, max field lengths enforced)',
|
|
2936
|
+
example: {
|
|
2937
|
+
source: 'MANUAL',
|
|
2938
|
+
note: 'Bank valuation report',
|
|
2939
|
+
confidence: 0.95
|
|
2940
|
+
}
|
|
2941
|
+
}
|
|
2942
|
+
},
|
|
2943
|
+
required: ['currency', 'quoteCurrency', 'amount', 'date']
|
|
2944
|
+
} as const;
|
|
2945
|
+
|
|
2946
|
+
export const $PriceResponseDto = {
|
|
2947
|
+
type: 'object',
|
|
2948
|
+
properties: {
|
|
2949
|
+
id: {
|
|
2950
|
+
type: 'string',
|
|
2951
|
+
description: 'Unique identifier',
|
|
2952
|
+
example: 'uuid-123-456'
|
|
2953
|
+
},
|
|
2954
|
+
userId: {
|
|
2955
|
+
type: 'string',
|
|
2956
|
+
description: 'User ID (owner of the price)',
|
|
2957
|
+
example: 'user-123'
|
|
2958
|
+
},
|
|
2959
|
+
currency: {
|
|
2960
|
+
type: 'string',
|
|
2961
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
2962
|
+
example: 'BTC'
|
|
2963
|
+
},
|
|
2964
|
+
quoteCurrency: {
|
|
2965
|
+
type: 'string',
|
|
2966
|
+
description: 'Quote currency (pricing currency, e.g., USD, CNY)',
|
|
2967
|
+
example: 'USD'
|
|
2968
|
+
},
|
|
2969
|
+
amount: {
|
|
2970
|
+
type: 'number',
|
|
2971
|
+
description:
|
|
2972
|
+
'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
|
|
2973
|
+
example: 50000
|
|
2974
|
+
},
|
|
2975
|
+
date: {
|
|
2976
|
+
type: 'string',
|
|
2977
|
+
description:
|
|
2978
|
+
'Price date (ISO 8601 format). Represents the date this price was valid.',
|
|
2979
|
+
example: '2024-01-01',
|
|
2980
|
+
format: 'date'
|
|
2981
|
+
},
|
|
2982
|
+
meta: {
|
|
2983
|
+
type: 'object',
|
|
2984
|
+
description:
|
|
2985
|
+
'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
|
|
2986
|
+
example: {
|
|
2987
|
+
source: 'MANUAL',
|
|
2988
|
+
note: 'User-defined price',
|
|
2989
|
+
confidence: 1
|
|
2990
|
+
}
|
|
2991
|
+
},
|
|
2992
|
+
createdAt: {
|
|
2993
|
+
format: 'date-time',
|
|
2994
|
+
type: 'string',
|
|
2995
|
+
description: 'Creation timestamp',
|
|
2996
|
+
example: '2024-11-03T10:00:00Z'
|
|
2997
|
+
},
|
|
2998
|
+
updatedAt: {
|
|
2999
|
+
format: 'date-time',
|
|
3000
|
+
type: 'string',
|
|
3001
|
+
description: 'Last update timestamp',
|
|
3002
|
+
example: '2024-11-03T10:00:00Z'
|
|
3003
|
+
}
|
|
3004
|
+
},
|
|
3005
|
+
required: [
|
|
3006
|
+
'id',
|
|
3007
|
+
'userId',
|
|
3008
|
+
'currency',
|
|
3009
|
+
'quoteCurrency',
|
|
3010
|
+
'amount',
|
|
3011
|
+
'date',
|
|
3012
|
+
'meta',
|
|
3013
|
+
'createdAt',
|
|
3014
|
+
'updatedAt'
|
|
3015
|
+
]
|
|
3016
|
+
} as const;
|
|
3017
|
+
|
|
3018
|
+
export const $PriceListResponseDto = {
|
|
3019
|
+
type: 'object',
|
|
3020
|
+
properties: {
|
|
3021
|
+
items: {
|
|
3022
|
+
description: 'List of prices',
|
|
3023
|
+
type: 'array',
|
|
3024
|
+
items: {
|
|
3025
|
+
$ref: '#/components/schemas/PriceResponseDto'
|
|
3026
|
+
}
|
|
3027
|
+
},
|
|
3028
|
+
total: {
|
|
3029
|
+
type: 'number',
|
|
3030
|
+
description: 'Total number of prices',
|
|
3031
|
+
example: 42
|
|
3032
|
+
}
|
|
3033
|
+
},
|
|
3034
|
+
required: ['items', 'total']
|
|
3035
|
+
} as const;
|
|
3036
|
+
|
|
3037
|
+
export const $UpdateBeanPriceDto = {
|
|
3038
|
+
type: 'object',
|
|
3039
|
+
properties: {
|
|
3040
|
+
currency: {
|
|
3041
|
+
type: 'string',
|
|
3042
|
+
description: 'Currency being priced'
|
|
3043
|
+
},
|
|
3044
|
+
quoteCurrency: {
|
|
3045
|
+
type: 'string',
|
|
3046
|
+
description: 'Quote currency (pricing currency)'
|
|
3047
|
+
},
|
|
3048
|
+
amount: {
|
|
3049
|
+
type: 'number',
|
|
3050
|
+
description: 'Price amount (MUST be >= 0 per Beancount spec)',
|
|
3051
|
+
minimum: 0
|
|
3052
|
+
},
|
|
3053
|
+
date: {
|
|
3054
|
+
type: 'string',
|
|
3055
|
+
description: 'Price date (ISO 8601 format)'
|
|
3056
|
+
},
|
|
3057
|
+
metadata: {
|
|
3058
|
+
type: 'object',
|
|
3059
|
+
description: 'Metadata'
|
|
3060
|
+
}
|
|
3061
|
+
}
|
|
3062
|
+
} as const;
|
|
3063
|
+
|
|
3064
|
+
export const $CreateRecurringRuleDto = {
|
|
3065
|
+
type: 'object',
|
|
3066
|
+
properties: {
|
|
3067
|
+
name: {
|
|
3068
|
+
type: 'string',
|
|
3069
|
+
description: 'Rule name (unique per user)',
|
|
3070
|
+
maxLength: 100
|
|
3071
|
+
},
|
|
3072
|
+
icon: {
|
|
3073
|
+
type: 'string',
|
|
3074
|
+
description: 'Icon emoji',
|
|
3075
|
+
maxLength: 10
|
|
3076
|
+
},
|
|
3077
|
+
frequency: {
|
|
3078
|
+
type: 'string',
|
|
3079
|
+
description: 'Recurring frequency',
|
|
3080
|
+
enum: [
|
|
3081
|
+
'WEEKLY',
|
|
3082
|
+
'BIWEEKLY',
|
|
3083
|
+
'MONTHLY',
|
|
3084
|
+
'BIMONTHLY',
|
|
3085
|
+
'QUARTERLY',
|
|
3086
|
+
'YEARLY',
|
|
3087
|
+
'CUSTOM'
|
|
3088
|
+
]
|
|
3089
|
+
},
|
|
3090
|
+
expectedAmount: {
|
|
3091
|
+
type: 'number',
|
|
3092
|
+
description: 'Expected amount (positive number)',
|
|
3093
|
+
minimum: 0
|
|
3094
|
+
},
|
|
3095
|
+
expectedDay: {
|
|
3096
|
+
type: 'number',
|
|
3097
|
+
description: 'Expected day of month (1-31)',
|
|
3098
|
+
minimum: 1,
|
|
3099
|
+
maximum: 31
|
|
3100
|
+
},
|
|
3101
|
+
customIntervalDays: {
|
|
3102
|
+
type: 'number',
|
|
3103
|
+
description: 'Custom interval in days (required for CUSTOM frequency)',
|
|
3104
|
+
minimum: 1
|
|
3105
|
+
},
|
|
3106
|
+
currency: {
|
|
3107
|
+
type: 'string',
|
|
3108
|
+
description: 'Currency code',
|
|
3109
|
+
default: 'CNY',
|
|
3110
|
+
maxLength: 10
|
|
3111
|
+
},
|
|
3112
|
+
matchPayeePattern: {
|
|
3113
|
+
type: 'string',
|
|
2753
3114
|
description: 'Payee matching pattern (supports wildcards)',
|
|
2754
3115
|
maxLength: 200
|
|
2755
3116
|
},
|
|
@@ -3471,281 +3832,473 @@ export const $ForecastResponseDto = {
|
|
|
3471
3832
|
]
|
|
3472
3833
|
} as const;
|
|
3473
3834
|
|
|
3474
|
-
export const $
|
|
3835
|
+
export const $CurrencyBalanceDto = {
|
|
3475
3836
|
type: 'object',
|
|
3476
3837
|
properties: {
|
|
3477
|
-
|
|
3838
|
+
currency: {
|
|
3478
3839
|
type: 'string',
|
|
3479
|
-
|
|
3480
|
-
|
|
3840
|
+
description: 'ISO 4217 currency code',
|
|
3841
|
+
example: 'CNY'
|
|
3481
3842
|
},
|
|
3482
|
-
|
|
3843
|
+
balance: {
|
|
3483
3844
|
type: 'string',
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
type: 'array'
|
|
3845
|
+
description: 'Balance amount',
|
|
3846
|
+
example: '500000.00'
|
|
3847
|
+
}
|
|
3848
|
+
},
|
|
3849
|
+
required: ['currency', 'balance']
|
|
3850
|
+
} as const;
|
|
3851
|
+
|
|
3852
|
+
export const $TimeSeriesPointDto = {
|
|
3853
|
+
type: 'object',
|
|
3854
|
+
properties: {
|
|
3855
|
+
date: {
|
|
3856
|
+
type: 'string',
|
|
3857
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3858
|
+
example: '2024-06-15'
|
|
3499
3859
|
},
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
maxItems: 50,
|
|
3505
|
-
type: 'array'
|
|
3860
|
+
value: {
|
|
3861
|
+
type: 'string',
|
|
3862
|
+
description: 'Value at this date (in base currency)',
|
|
3863
|
+
example: '500000.00'
|
|
3506
3864
|
},
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
maxItems: 50,
|
|
3512
|
-
description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
|
|
3513
|
-
type: 'array'
|
|
3865
|
+
change: {
|
|
3866
|
+
type: 'object',
|
|
3867
|
+
description: 'Change from previous point',
|
|
3868
|
+
example: '5000.00'
|
|
3514
3869
|
},
|
|
3515
|
-
|
|
3870
|
+
assets: {
|
|
3516
3871
|
type: 'string',
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
|
|
3872
|
+
description: 'Total assets at this date (in base currency)',
|
|
3873
|
+
example: '494338.00'
|
|
3520
3874
|
},
|
|
3521
|
-
|
|
3875
|
+
liabilities: {
|
|
3522
3876
|
type: 'string',
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
},
|
|
3526
|
-
amountMin: {
|
|
3527
|
-
type: 'number',
|
|
3528
|
-
minimum: 0,
|
|
3529
|
-
description: 'Minimum transaction amount (inclusive)'
|
|
3877
|
+
description: 'Total liabilities at this date (in base currency)',
|
|
3878
|
+
example: '310098.00'
|
|
3530
3879
|
},
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
description: 'Maximum transaction amount (inclusive)'
|
|
3535
|
-
},
|
|
3536
|
-
priority: {
|
|
3537
|
-
type: 'number',
|
|
3538
|
-
default: 50,
|
|
3539
|
-
minimum: 0,
|
|
3540
|
-
maximum: 1000
|
|
3541
|
-
},
|
|
3542
|
-
additionalTags: {
|
|
3880
|
+
byCurrency: {
|
|
3881
|
+
description: 'Multi-currency breakdown for this point',
|
|
3882
|
+
type: 'array',
|
|
3543
3883
|
items: {
|
|
3544
|
-
|
|
3545
|
-
}
|
|
3546
|
-
maxItems: 20,
|
|
3547
|
-
type: 'array'
|
|
3548
|
-
},
|
|
3549
|
-
additionalMetadata: {
|
|
3550
|
-
type: 'object'
|
|
3551
|
-
},
|
|
3552
|
-
upsertByPayee: {
|
|
3553
|
-
type: 'boolean',
|
|
3554
|
-
description:
|
|
3555
|
-
'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
|
|
3884
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3885
|
+
}
|
|
3556
3886
|
}
|
|
3557
3887
|
},
|
|
3558
|
-
required: ['
|
|
3888
|
+
required: ['date', 'value']
|
|
3559
3889
|
} as const;
|
|
3560
3890
|
|
|
3561
|
-
export const $
|
|
3891
|
+
export const $TrendSummaryDto = {
|
|
3562
3892
|
type: 'object',
|
|
3563
3893
|
properties: {
|
|
3564
|
-
|
|
3565
|
-
type: '
|
|
3566
|
-
description: '
|
|
3894
|
+
startValue: {
|
|
3895
|
+
type: 'string',
|
|
3896
|
+
description: 'Value at start of period',
|
|
3897
|
+
example: '450000.00'
|
|
3567
3898
|
},
|
|
3568
|
-
|
|
3569
|
-
type: '
|
|
3570
|
-
description: '
|
|
3899
|
+
endValue: {
|
|
3900
|
+
type: 'string',
|
|
3901
|
+
description: 'Value at end of period',
|
|
3902
|
+
example: '500000.00'
|
|
3903
|
+
},
|
|
3904
|
+
totalChange: {
|
|
3905
|
+
type: 'string',
|
|
3906
|
+
description: 'Total change over period',
|
|
3907
|
+
example: '50000.00'
|
|
3908
|
+
},
|
|
3909
|
+
totalChangePercentage: {
|
|
3910
|
+
type: 'string',
|
|
3911
|
+
description: 'Total change percentage',
|
|
3912
|
+
example: '+11.11%'
|
|
3571
3913
|
}
|
|
3572
|
-
}
|
|
3914
|
+
},
|
|
3915
|
+
required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
|
|
3573
3916
|
} as const;
|
|
3574
3917
|
|
|
3575
|
-
export const $
|
|
3918
|
+
export const $MultiCurrencyPointDto = {
|
|
3576
3919
|
type: 'object',
|
|
3577
3920
|
properties: {
|
|
3578
|
-
|
|
3579
|
-
type: 'string',
|
|
3580
|
-
description: 'Rule ID'
|
|
3581
|
-
},
|
|
3582
|
-
name: {
|
|
3583
|
-
type: 'string',
|
|
3584
|
-
description: 'Rule name'
|
|
3585
|
-
},
|
|
3586
|
-
description: {
|
|
3921
|
+
date: {
|
|
3587
3922
|
type: 'string',
|
|
3588
|
-
description: '
|
|
3589
|
-
|
|
3590
|
-
narrationKeywords: {
|
|
3591
|
-
description: 'Keywords to match in transaction narration',
|
|
3592
|
-
type: 'array',
|
|
3593
|
-
items: {
|
|
3594
|
-
type: 'string'
|
|
3595
|
-
}
|
|
3596
|
-
},
|
|
3597
|
-
payeeKeywords: {
|
|
3598
|
-
description: 'Keywords to match in payee name',
|
|
3599
|
-
type: 'array',
|
|
3600
|
-
items: {
|
|
3601
|
-
type: 'string'
|
|
3602
|
-
}
|
|
3923
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3924
|
+
example: '2024-06-15'
|
|
3603
3925
|
},
|
|
3604
|
-
|
|
3605
|
-
description: '
|
|
3926
|
+
byCurrency: {
|
|
3927
|
+
description: 'Balances by currency',
|
|
3606
3928
|
type: 'array',
|
|
3607
3929
|
items: {
|
|
3608
|
-
|
|
3930
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3609
3931
|
}
|
|
3610
|
-
}
|
|
3611
|
-
|
|
3612
|
-
|
|
3932
|
+
}
|
|
3933
|
+
},
|
|
3934
|
+
required: ['date', 'byCurrency']
|
|
3935
|
+
} as const;
|
|
3936
|
+
|
|
3937
|
+
export const $PortfolioTrendsResponseDto = {
|
|
3938
|
+
type: 'object',
|
|
3939
|
+
properties: {
|
|
3940
|
+
series: {
|
|
3941
|
+
description: 'Time series data points',
|
|
3613
3942
|
type: 'array',
|
|
3614
3943
|
items: {
|
|
3615
|
-
|
|
3944
|
+
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
3616
3945
|
}
|
|
3617
3946
|
},
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
description: 'Destination account for categorization'
|
|
3621
|
-
},
|
|
3622
|
-
matchLogic: {
|
|
3623
|
-
type: 'string',
|
|
3624
|
-
description: 'Keyword matching logic',
|
|
3625
|
-
enum: ['OR', 'AND'],
|
|
3626
|
-
example: 'OR'
|
|
3627
|
-
},
|
|
3628
|
-
amountRange: {
|
|
3629
|
-
description: 'Amount range for matching',
|
|
3947
|
+
summary: {
|
|
3948
|
+
description: 'Period summary',
|
|
3630
3949
|
allOf: [
|
|
3631
3950
|
{
|
|
3632
|
-
$ref: '#/components/schemas/
|
|
3951
|
+
$ref: '#/components/schemas/TrendSummaryDto'
|
|
3633
3952
|
}
|
|
3634
3953
|
]
|
|
3635
3954
|
},
|
|
3636
|
-
|
|
3637
|
-
type: 'number',
|
|
3638
|
-
description: 'Rule priority (0-1000, higher = first match)',
|
|
3639
|
-
example: 50
|
|
3640
|
-
},
|
|
3641
|
-
enabled: {
|
|
3642
|
-
type: 'boolean',
|
|
3643
|
-
description: 'Whether the rule is enabled'
|
|
3644
|
-
},
|
|
3645
|
-
learningSource: {
|
|
3955
|
+
period: {
|
|
3646
3956
|
type: 'string',
|
|
3647
|
-
description: '
|
|
3648
|
-
|
|
3649
|
-
nullable: true,
|
|
3650
|
-
example: 'REVIEW_CENTER'
|
|
3957
|
+
description: 'Period requested',
|
|
3958
|
+
example: '6m'
|
|
3651
3959
|
},
|
|
3652
|
-
|
|
3653
|
-
type: '
|
|
3654
|
-
description: '
|
|
3960
|
+
granularity: {
|
|
3961
|
+
type: 'string',
|
|
3962
|
+
description: 'Data granularity',
|
|
3963
|
+
example: 'month'
|
|
3655
3964
|
},
|
|
3656
|
-
|
|
3657
|
-
type: '
|
|
3658
|
-
description: '
|
|
3659
|
-
example:
|
|
3965
|
+
currency: {
|
|
3966
|
+
type: 'string',
|
|
3967
|
+
description: 'Base currency for converted values',
|
|
3968
|
+
example: 'CNY'
|
|
3660
3969
|
},
|
|
3661
|
-
|
|
3662
|
-
description:
|
|
3970
|
+
byCurrency: {
|
|
3971
|
+
description:
|
|
3972
|
+
'Multi-currency time series (each point has currency breakdown)',
|
|
3663
3973
|
type: 'array',
|
|
3664
3974
|
items: {
|
|
3665
|
-
|
|
3975
|
+
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
3666
3976
|
}
|
|
3667
3977
|
},
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
|
|
3978
|
+
warnings: {
|
|
3979
|
+
description: 'Exchange rate warnings',
|
|
3980
|
+
type: 'array',
|
|
3981
|
+
items: {
|
|
3982
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
3673
3983
|
}
|
|
3674
|
-
},
|
|
3675
|
-
createdAt: {
|
|
3676
|
-
format: 'date-time',
|
|
3677
|
-
type: 'string',
|
|
3678
|
-
description: 'Created timestamp'
|
|
3679
|
-
},
|
|
3680
|
-
updatedAt: {
|
|
3681
|
-
format: 'date-time',
|
|
3682
|
-
type: 'string',
|
|
3683
|
-
description: 'Updated timestamp'
|
|
3684
3984
|
}
|
|
3685
3985
|
},
|
|
3686
|
-
required: [
|
|
3687
|
-
'id',
|
|
3688
|
-
'name',
|
|
3689
|
-
'narrationKeywords',
|
|
3690
|
-
'payeeKeywords',
|
|
3691
|
-
'categoryKeywords',
|
|
3692
|
-
'methodKeywords',
|
|
3693
|
-
'matchLogic',
|
|
3694
|
-
'priority',
|
|
3695
|
-
'enabled',
|
|
3696
|
-
'autoApplyEnabled',
|
|
3697
|
-
'confirmationCount',
|
|
3698
|
-
'additionalTags',
|
|
3699
|
-
'createdAt',
|
|
3700
|
-
'updatedAt'
|
|
3701
|
-
]
|
|
3986
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
3702
3987
|
} as const;
|
|
3703
3988
|
|
|
3704
|
-
export const $
|
|
3989
|
+
export const $CashFlowPointDto = {
|
|
3705
3990
|
type: 'object',
|
|
3706
3991
|
properties: {
|
|
3707
|
-
|
|
3708
|
-
type: '
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
}
|
|
3992
|
+
month: {
|
|
3993
|
+
type: 'string',
|
|
3994
|
+
description: 'Month key (YYYY-MM)',
|
|
3995
|
+
example: '2024-03'
|
|
3712
3996
|
},
|
|
3713
|
-
|
|
3714
|
-
type: '
|
|
3715
|
-
description: '
|
|
3997
|
+
income: {
|
|
3998
|
+
type: 'string',
|
|
3999
|
+
description: 'Income in base currency (absolute, converted)',
|
|
4000
|
+
example: '10000.00'
|
|
3716
4001
|
},
|
|
3717
|
-
|
|
3718
|
-
type: '
|
|
3719
|
-
description: '
|
|
4002
|
+
expense: {
|
|
4003
|
+
type: 'string',
|
|
4004
|
+
description: 'Expense in base currency (absolute, converted)',
|
|
4005
|
+
example: '5000.00'
|
|
3720
4006
|
},
|
|
3721
|
-
|
|
3722
|
-
type: '
|
|
3723
|
-
description: '
|
|
4007
|
+
netSavings: {
|
|
4008
|
+
type: 'string',
|
|
4009
|
+
description: 'netSavings = income − expense (savings positive)',
|
|
4010
|
+
example: '5000.00'
|
|
3724
4011
|
}
|
|
3725
4012
|
},
|
|
3726
|
-
required: ['
|
|
4013
|
+
required: ['month', 'income', 'expense', 'netSavings']
|
|
3727
4014
|
} as const;
|
|
3728
4015
|
|
|
3729
|
-
export const $
|
|
4016
|
+
export const $CashFlowTrendSummaryDto = {
|
|
3730
4017
|
type: 'object',
|
|
3731
4018
|
properties: {
|
|
3732
|
-
|
|
4019
|
+
totalIncome: {
|
|
3733
4020
|
type: 'string',
|
|
3734
|
-
|
|
3735
|
-
|
|
4021
|
+
description: 'Total income across the period',
|
|
4022
|
+
example: '60000.00'
|
|
3736
4023
|
},
|
|
3737
|
-
|
|
4024
|
+
totalExpense: {
|
|
3738
4025
|
type: 'string',
|
|
3739
|
-
|
|
4026
|
+
description: 'Total expense across the period',
|
|
4027
|
+
example: '30000.00'
|
|
3740
4028
|
},
|
|
3741
|
-
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
maxItems: 50,
|
|
3746
|
-
type: 'array'
|
|
4029
|
+
totalNetSavings: {
|
|
4030
|
+
type: 'string',
|
|
4031
|
+
description: 'income − expense across the period',
|
|
4032
|
+
example: '30000.00'
|
|
3747
4033
|
},
|
|
3748
|
-
|
|
4034
|
+
averageMonthlyNetSavings: {
|
|
4035
|
+
type: 'string',
|
|
4036
|
+
description:
|
|
4037
|
+
'totalNetSavings divided by the window length (N months, incl. zero-filled)',
|
|
4038
|
+
example: '5000.00'
|
|
4039
|
+
}
|
|
4040
|
+
},
|
|
4041
|
+
required: [
|
|
4042
|
+
'totalIncome',
|
|
4043
|
+
'totalExpense',
|
|
4044
|
+
'totalNetSavings',
|
|
4045
|
+
'averageMonthlyNetSavings'
|
|
4046
|
+
]
|
|
4047
|
+
} as const;
|
|
4048
|
+
|
|
4049
|
+
export const $CashFlowTrendsResponseDto = {
|
|
4050
|
+
type: 'object',
|
|
4051
|
+
properties: {
|
|
4052
|
+
series: {
|
|
4053
|
+
description:
|
|
4054
|
+
'Monthly cash-flow series (fixed N-month window, zero-filled)',
|
|
4055
|
+
type: 'array',
|
|
4056
|
+
items: {
|
|
4057
|
+
$ref: '#/components/schemas/CashFlowPointDto'
|
|
4058
|
+
}
|
|
4059
|
+
},
|
|
4060
|
+
summary: {
|
|
4061
|
+
description: 'Period totals',
|
|
4062
|
+
allOf: [
|
|
4063
|
+
{
|
|
4064
|
+
$ref: '#/components/schemas/CashFlowTrendSummaryDto'
|
|
4065
|
+
}
|
|
4066
|
+
]
|
|
4067
|
+
},
|
|
4068
|
+
period: {
|
|
4069
|
+
type: 'string',
|
|
4070
|
+
description: 'Period requested',
|
|
4071
|
+
example: '6m'
|
|
4072
|
+
},
|
|
4073
|
+
granularity: {
|
|
4074
|
+
type: 'string',
|
|
4075
|
+
description: 'Data granularity (v1 returns month buckets)',
|
|
4076
|
+
example: 'month'
|
|
4077
|
+
},
|
|
4078
|
+
currency: {
|
|
4079
|
+
type: 'string',
|
|
4080
|
+
description: 'Base currency for converted values',
|
|
4081
|
+
example: 'CNY'
|
|
4082
|
+
},
|
|
4083
|
+
warnings: {
|
|
4084
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
4085
|
+
type: 'array',
|
|
4086
|
+
items: {
|
|
4087
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
4088
|
+
}
|
|
4089
|
+
}
|
|
4090
|
+
},
|
|
4091
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
4092
|
+
} as const;
|
|
4093
|
+
|
|
4094
|
+
export const $GenerateSnapshotBody = {
|
|
4095
|
+
type: 'object',
|
|
4096
|
+
properties: {}
|
|
4097
|
+
} as const;
|
|
4098
|
+
|
|
4099
|
+
export const $GenerateSnapshotResponse = {
|
|
4100
|
+
type: 'object',
|
|
4101
|
+
properties: {}
|
|
4102
|
+
} as const;
|
|
4103
|
+
|
|
4104
|
+
export const $BackfillSnapshotsBody = {
|
|
4105
|
+
type: 'object',
|
|
4106
|
+
properties: {}
|
|
4107
|
+
} as const;
|
|
4108
|
+
|
|
4109
|
+
export const $BackfillSnapshotsResponse = {
|
|
4110
|
+
type: 'object',
|
|
4111
|
+
properties: {}
|
|
4112
|
+
} as const;
|
|
4113
|
+
|
|
4114
|
+
export const $DeleteOwnUserDto = {
|
|
4115
|
+
type: 'object',
|
|
4116
|
+
properties: {
|
|
4117
|
+
accessToken: {
|
|
4118
|
+
type: 'string',
|
|
4119
|
+
description: 'Access token for user verification',
|
|
4120
|
+
example: 'abc123xyz'
|
|
4121
|
+
}
|
|
4122
|
+
},
|
|
4123
|
+
required: ['accessToken']
|
|
4124
|
+
} as const;
|
|
4125
|
+
|
|
4126
|
+
export const $SignupDto = {
|
|
4127
|
+
type: 'object',
|
|
4128
|
+
properties: {
|
|
4129
|
+
turnstileToken: {
|
|
4130
|
+
type: 'string',
|
|
4131
|
+
description:
|
|
4132
|
+
'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
|
|
4133
|
+
example: '0.abc123def456...'
|
|
4134
|
+
}
|
|
4135
|
+
}
|
|
4136
|
+
} as const;
|
|
4137
|
+
|
|
4138
|
+
export const $SignupResponseDto = {
|
|
4139
|
+
type: 'object',
|
|
4140
|
+
properties: {
|
|
4141
|
+
authToken: {
|
|
4142
|
+
type: 'string',
|
|
4143
|
+
description: 'JWT auth token',
|
|
4144
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
4145
|
+
},
|
|
4146
|
+
accessToken: {
|
|
4147
|
+
type: 'string',
|
|
4148
|
+
description: 'Auto-generated access token'
|
|
4149
|
+
},
|
|
4150
|
+
role: {
|
|
4151
|
+
type: 'string',
|
|
4152
|
+
description: 'Assigned user role',
|
|
4153
|
+
enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
|
|
4154
|
+
}
|
|
4155
|
+
},
|
|
4156
|
+
required: ['authToken', 'accessToken', 'role']
|
|
4157
|
+
} as const;
|
|
4158
|
+
|
|
4159
|
+
export const $UpdateUserSettingDto = {
|
|
4160
|
+
type: 'object',
|
|
4161
|
+
properties: {
|
|
4162
|
+
secId: {
|
|
4163
|
+
type: 'number',
|
|
4164
|
+
description: 'Security ID'
|
|
4165
|
+
},
|
|
4166
|
+
annualInterestRate: {
|
|
4167
|
+
type: 'number',
|
|
4168
|
+
description: 'Annual interest rate',
|
|
4169
|
+
example: 0.05
|
|
4170
|
+
},
|
|
4171
|
+
currency: {
|
|
4172
|
+
type: 'string',
|
|
4173
|
+
description: 'Currency code',
|
|
4174
|
+
example: 'USD'
|
|
4175
|
+
},
|
|
4176
|
+
baseCurrency: {
|
|
4177
|
+
type: 'string',
|
|
4178
|
+
description: 'Base currency code',
|
|
4179
|
+
example: 'USD'
|
|
4180
|
+
},
|
|
4181
|
+
benchmark: {
|
|
4182
|
+
type: 'string',
|
|
4183
|
+
description: 'Benchmark symbol',
|
|
4184
|
+
example: 'SPY'
|
|
4185
|
+
},
|
|
4186
|
+
colorScheme: {
|
|
4187
|
+
type: 'string',
|
|
4188
|
+
description: 'Color scheme',
|
|
4189
|
+
enum: ['DARK', 'LIGHT']
|
|
4190
|
+
},
|
|
4191
|
+
dateRange: {
|
|
4192
|
+
type: 'string',
|
|
4193
|
+
description: 'Date range filter',
|
|
4194
|
+
example: '1y'
|
|
4195
|
+
},
|
|
4196
|
+
emergencyFund: {
|
|
4197
|
+
type: 'number',
|
|
4198
|
+
description: 'Emergency fund amount',
|
|
4199
|
+
example: 10000
|
|
4200
|
+
},
|
|
4201
|
+
'filters.accounts': {
|
|
4202
|
+
description: 'Account filter IDs',
|
|
4203
|
+
type: 'array',
|
|
4204
|
+
items: {
|
|
4205
|
+
type: 'string'
|
|
4206
|
+
}
|
|
4207
|
+
},
|
|
4208
|
+
'filters.assetClasses': {
|
|
4209
|
+
description: 'Asset class filters',
|
|
4210
|
+
type: 'array',
|
|
4211
|
+
items: {
|
|
4212
|
+
type: 'string'
|
|
4213
|
+
}
|
|
4214
|
+
},
|
|
4215
|
+
'filters.dataSource': {
|
|
4216
|
+
type: 'string',
|
|
4217
|
+
description: 'Data source filter'
|
|
4218
|
+
},
|
|
4219
|
+
'filters.symbol': {
|
|
4220
|
+
type: 'string',
|
|
4221
|
+
description: 'Symbol filter'
|
|
4222
|
+
},
|
|
4223
|
+
'filters.tags': {
|
|
4224
|
+
description: 'Tag filters',
|
|
4225
|
+
type: 'array',
|
|
4226
|
+
items: {
|
|
4227
|
+
type: 'string'
|
|
4228
|
+
}
|
|
4229
|
+
},
|
|
4230
|
+
isExperimentalFeatures: {
|
|
4231
|
+
type: 'boolean',
|
|
4232
|
+
description: 'Enable experimental features'
|
|
4233
|
+
},
|
|
4234
|
+
isRestrictedView: {
|
|
4235
|
+
type: 'boolean',
|
|
4236
|
+
description: 'Enable restricted view mode'
|
|
4237
|
+
},
|
|
4238
|
+
language: {
|
|
4239
|
+
type: 'string',
|
|
4240
|
+
description: 'Language code',
|
|
4241
|
+
example: 'en'
|
|
4242
|
+
},
|
|
4243
|
+
locale: {
|
|
4244
|
+
type: 'string',
|
|
4245
|
+
description: 'Locale code',
|
|
4246
|
+
example: 'en-US'
|
|
4247
|
+
},
|
|
4248
|
+
projectedTotalAmount: {
|
|
4249
|
+
type: 'number',
|
|
4250
|
+
description: 'Projected total amount',
|
|
4251
|
+
example: 1000000
|
|
4252
|
+
},
|
|
4253
|
+
retirementDate: {
|
|
4254
|
+
type: 'string',
|
|
4255
|
+
description: 'Retirement date in ISO 8601 format',
|
|
4256
|
+
example: '2050-01-01'
|
|
4257
|
+
},
|
|
4258
|
+
savingsRate: {
|
|
4259
|
+
type: 'number',
|
|
4260
|
+
description: 'Savings rate percentage',
|
|
4261
|
+
example: 0.2
|
|
4262
|
+
},
|
|
4263
|
+
viewMode: {
|
|
4264
|
+
type: 'string',
|
|
4265
|
+
description: 'View mode',
|
|
4266
|
+
enum: ['DEFAULT', 'ZEN']
|
|
4267
|
+
}
|
|
4268
|
+
}
|
|
4269
|
+
} as const;
|
|
4270
|
+
|
|
4271
|
+
export const $UpdatePropertyDto = {
|
|
4272
|
+
type: 'object',
|
|
4273
|
+
properties: {
|
|
4274
|
+
value: {
|
|
4275
|
+
type: 'string',
|
|
4276
|
+
description: 'Property value'
|
|
4277
|
+
}
|
|
4278
|
+
},
|
|
4279
|
+
required: ['value']
|
|
4280
|
+
} as const;
|
|
4281
|
+
|
|
4282
|
+
export const $CreateTransactionRuleDto = {
|
|
4283
|
+
type: 'object',
|
|
4284
|
+
properties: {
|
|
4285
|
+
name: {
|
|
4286
|
+
type: 'string',
|
|
4287
|
+
minLength: 1,
|
|
4288
|
+
maxLength: 100
|
|
4289
|
+
},
|
|
4290
|
+
description: {
|
|
4291
|
+
type: 'string',
|
|
4292
|
+
maxLength: 500
|
|
4293
|
+
},
|
|
4294
|
+
narrationKeywords: {
|
|
4295
|
+
items: {
|
|
4296
|
+
type: 'array'
|
|
4297
|
+
},
|
|
4298
|
+
maxItems: 50,
|
|
4299
|
+
type: 'array'
|
|
4300
|
+
},
|
|
4301
|
+
payeeKeywords: {
|
|
3749
4302
|
items: {
|
|
3750
4303
|
type: 'array'
|
|
3751
4304
|
},
|
|
@@ -3813,175 +4366,175 @@ export const $ValidateRuleDto = {
|
|
|
3813
4366
|
required: ['name', 'matchLogic', 'priority']
|
|
3814
4367
|
} as const;
|
|
3815
4368
|
|
|
3816
|
-
export const $
|
|
4369
|
+
export const $AmountRangeDto = {
|
|
3817
4370
|
type: 'object',
|
|
3818
4371
|
properties: {
|
|
3819
|
-
|
|
3820
|
-
type: '
|
|
3821
|
-
description: '
|
|
3822
|
-
example: true
|
|
3823
|
-
},
|
|
3824
|
-
errors: {
|
|
3825
|
-
description: 'List of validation errors (empty if valid)',
|
|
3826
|
-
example: [],
|
|
3827
|
-
items: {
|
|
3828
|
-
type: 'array'
|
|
3829
|
-
},
|
|
3830
|
-
type: 'array'
|
|
4372
|
+
min: {
|
|
4373
|
+
type: 'number',
|
|
4374
|
+
description: 'Minimum amount'
|
|
3831
4375
|
},
|
|
3832
|
-
|
|
3833
|
-
|
|
3834
|
-
|
|
3835
|
-
'No account constraints specified - rule will match any account'
|
|
3836
|
-
],
|
|
3837
|
-
items: {
|
|
3838
|
-
type: 'array'
|
|
3839
|
-
},
|
|
3840
|
-
type: 'array'
|
|
4376
|
+
max: {
|
|
4377
|
+
type: 'number',
|
|
4378
|
+
description: 'Maximum amount'
|
|
3841
4379
|
}
|
|
3842
|
-
}
|
|
3843
|
-
required: ['valid', 'errors', 'warnings']
|
|
4380
|
+
}
|
|
3844
4381
|
} as const;
|
|
3845
4382
|
|
|
3846
|
-
export const $
|
|
4383
|
+
export const $TransactionRuleResponseDto = {
|
|
3847
4384
|
type: 'object',
|
|
3848
4385
|
properties: {
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
},
|
|
3853
|
-
description: 'Array of rules to import',
|
|
3854
|
-
type: 'array'
|
|
4386
|
+
id: {
|
|
4387
|
+
type: 'string',
|
|
4388
|
+
description: 'Rule ID'
|
|
3855
4389
|
},
|
|
3856
|
-
|
|
4390
|
+
name: {
|
|
3857
4391
|
type: 'string',
|
|
3858
|
-
|
|
3859
|
-
default: 'skip',
|
|
3860
|
-
description:
|
|
3861
|
-
'Conflict handling strategy: skip (default) ignores duplicates, replace soft-deletes existing rule'
|
|
3862
|
-
}
|
|
3863
|
-
},
|
|
3864
|
-
required: ['rules', 'conflictStrategy']
|
|
3865
|
-
} as const;
|
|
3866
|
-
|
|
3867
|
-
export const $BulkCreateRulesResponseDto = {
|
|
3868
|
-
type: 'object',
|
|
3869
|
-
properties: {
|
|
3870
|
-
successCount: {
|
|
3871
|
-
type: 'number',
|
|
3872
|
-
description: 'Number of successfully created rules'
|
|
4392
|
+
description: 'Rule name'
|
|
3873
4393
|
},
|
|
3874
|
-
|
|
3875
|
-
type: '
|
|
3876
|
-
description: '
|
|
4394
|
+
description: {
|
|
4395
|
+
type: 'string',
|
|
4396
|
+
description: 'Rule description'
|
|
3877
4397
|
},
|
|
3878
|
-
|
|
4398
|
+
narrationKeywords: {
|
|
4399
|
+
description: 'Keywords to match in transaction narration',
|
|
3879
4400
|
type: 'array',
|
|
3880
|
-
description: 'Error details for failed rules',
|
|
3881
4401
|
items: {
|
|
3882
|
-
type: '
|
|
3883
|
-
properties: {
|
|
3884
|
-
index: {
|
|
3885
|
-
type: 'number'
|
|
3886
|
-
},
|
|
3887
|
-
message: {
|
|
3888
|
-
type: 'string'
|
|
3889
|
-
}
|
|
3890
|
-
}
|
|
4402
|
+
type: 'string'
|
|
3891
4403
|
}
|
|
3892
4404
|
},
|
|
3893
|
-
|
|
3894
|
-
description: '
|
|
4405
|
+
payeeKeywords: {
|
|
4406
|
+
description: 'Keywords to match in payee name',
|
|
3895
4407
|
type: 'array',
|
|
3896
4408
|
items: {
|
|
3897
4409
|
type: 'string'
|
|
3898
4410
|
}
|
|
3899
|
-
}
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
4411
|
+
},
|
|
4412
|
+
categoryKeywords: {
|
|
4413
|
+
description: 'Keywords to match in category',
|
|
4414
|
+
type: 'array',
|
|
4415
|
+
items: {
|
|
4416
|
+
type: 'string'
|
|
4417
|
+
}
|
|
4418
|
+
},
|
|
4419
|
+
methodKeywords: {
|
|
4420
|
+
description: 'Keywords to match in payment method',
|
|
4421
|
+
type: 'array',
|
|
4422
|
+
items: {
|
|
4423
|
+
type: 'string'
|
|
4424
|
+
}
|
|
4425
|
+
},
|
|
4426
|
+
categoryAccount: {
|
|
3908
4427
|
type: 'string',
|
|
3909
|
-
description: '
|
|
4428
|
+
description: 'Destination account for categorization'
|
|
3910
4429
|
},
|
|
3911
|
-
|
|
4430
|
+
matchLogic: {
|
|
3912
4431
|
type: 'string',
|
|
3913
|
-
description: '
|
|
4432
|
+
description: 'Keyword matching logic',
|
|
4433
|
+
enum: ['OR', 'AND'],
|
|
4434
|
+
example: 'OR'
|
|
3914
4435
|
},
|
|
3915
|
-
|
|
4436
|
+
amountRange: {
|
|
4437
|
+
description: 'Amount range for matching',
|
|
4438
|
+
allOf: [
|
|
4439
|
+
{
|
|
4440
|
+
$ref: '#/components/schemas/AmountRangeDto'
|
|
4441
|
+
}
|
|
4442
|
+
]
|
|
4443
|
+
},
|
|
4444
|
+
priority: {
|
|
3916
4445
|
type: 'number',
|
|
3917
|
-
description: '
|
|
4446
|
+
description: 'Rule priority (0-1000, higher = first match)',
|
|
4447
|
+
example: 50
|
|
3918
4448
|
},
|
|
3919
|
-
|
|
4449
|
+
enabled: {
|
|
4450
|
+
type: 'boolean',
|
|
4451
|
+
description: 'Whether the rule is enabled'
|
|
4452
|
+
},
|
|
4453
|
+
learningSource: {
|
|
4454
|
+
type: 'string',
|
|
4455
|
+
description: 'Learning source: NLP, REVIEW_CENTER, or null for manual',
|
|
4456
|
+
enum: ['NLP', 'REVIEW_CENTER'],
|
|
4457
|
+
nullable: true,
|
|
4458
|
+
example: 'REVIEW_CENTER'
|
|
4459
|
+
},
|
|
4460
|
+
autoApplyEnabled: {
|
|
4461
|
+
type: 'boolean',
|
|
4462
|
+
description: 'Whether auto-apply is enabled for this rule'
|
|
4463
|
+
},
|
|
4464
|
+
confirmationCount: {
|
|
4465
|
+
type: 'number',
|
|
4466
|
+
description: 'Number of confirmations for NLP-learned rules',
|
|
4467
|
+
example: 3
|
|
4468
|
+
},
|
|
4469
|
+
additionalTags: {
|
|
4470
|
+
description: 'Additional tags',
|
|
3920
4471
|
type: 'array',
|
|
3921
|
-
|
|
4472
|
+
items: {
|
|
4473
|
+
type: 'string'
|
|
4474
|
+
}
|
|
4475
|
+
},
|
|
4476
|
+
additionalMetadata: {
|
|
4477
|
+
type: 'object',
|
|
4478
|
+
description: 'Additional metadata',
|
|
4479
|
+
additionalProperties: {
|
|
4480
|
+
type: 'string'
|
|
4481
|
+
}
|
|
4482
|
+
},
|
|
4483
|
+
createdAt: {
|
|
4484
|
+
format: 'date-time',
|
|
4485
|
+
type: 'string',
|
|
4486
|
+
description: 'Created timestamp'
|
|
4487
|
+
},
|
|
4488
|
+
updatedAt: {
|
|
4489
|
+
format: 'date-time',
|
|
4490
|
+
type: 'string',
|
|
4491
|
+
description: 'Updated timestamp'
|
|
3922
4492
|
}
|
|
3923
4493
|
},
|
|
3924
|
-
required: [
|
|
4494
|
+
required: [
|
|
4495
|
+
'id',
|
|
4496
|
+
'name',
|
|
4497
|
+
'narrationKeywords',
|
|
4498
|
+
'payeeKeywords',
|
|
4499
|
+
'categoryKeywords',
|
|
4500
|
+
'methodKeywords',
|
|
4501
|
+
'matchLogic',
|
|
4502
|
+
'priority',
|
|
4503
|
+
'enabled',
|
|
4504
|
+
'autoApplyEnabled',
|
|
4505
|
+
'confirmationCount',
|
|
4506
|
+
'additionalTags',
|
|
4507
|
+
'createdAt',
|
|
4508
|
+
'updatedAt'
|
|
4509
|
+
]
|
|
3925
4510
|
} as const;
|
|
3926
4511
|
|
|
3927
|
-
export const $
|
|
4512
|
+
export const $TransactionRuleListResponseDto = {
|
|
3928
4513
|
type: 'object',
|
|
3929
4514
|
properties: {
|
|
3930
|
-
|
|
3931
|
-
type: '
|
|
3932
|
-
|
|
3933
|
-
|
|
3934
|
-
|
|
3935
|
-
totalRules: {
|
|
3936
|
-
type: 'number',
|
|
3937
|
-
description: 'Total number of rules'
|
|
4515
|
+
data: {
|
|
4516
|
+
type: 'array',
|
|
4517
|
+
items: {
|
|
4518
|
+
$ref: '#/components/schemas/TransactionRuleResponseDto'
|
|
4519
|
+
}
|
|
3938
4520
|
},
|
|
3939
|
-
|
|
4521
|
+
total: {
|
|
3940
4522
|
type: 'number',
|
|
3941
|
-
description: '
|
|
4523
|
+
description: 'Total count of rules'
|
|
3942
4524
|
},
|
|
3943
|
-
|
|
4525
|
+
limit: {
|
|
3944
4526
|
type: 'number',
|
|
3945
|
-
description: '
|
|
4527
|
+
description: 'Results per page'
|
|
3946
4528
|
},
|
|
3947
|
-
|
|
4529
|
+
offset: {
|
|
3948
4530
|
type: 'number',
|
|
3949
|
-
description: '
|
|
3950
|
-
example: 0.82
|
|
3951
|
-
},
|
|
3952
|
-
ruleStats: {
|
|
3953
|
-
type: 'array',
|
|
3954
|
-
description: 'Per-rule statistics',
|
|
3955
|
-
items: {
|
|
3956
|
-
type: 'object',
|
|
3957
|
-
properties: {
|
|
3958
|
-
ruleId: {
|
|
3959
|
-
type: 'string'
|
|
3960
|
-
},
|
|
3961
|
-
ruleName: {
|
|
3962
|
-
type: 'string'
|
|
3963
|
-
},
|
|
3964
|
-
matchCount: {
|
|
3965
|
-
type: 'number'
|
|
3966
|
-
},
|
|
3967
|
-
averageConfidence: {
|
|
3968
|
-
type: 'number'
|
|
3969
|
-
}
|
|
3970
|
-
}
|
|
3971
|
-
}
|
|
4531
|
+
description: 'Pagination offset'
|
|
3972
4532
|
}
|
|
3973
4533
|
},
|
|
3974
|
-
required: [
|
|
3975
|
-
'period',
|
|
3976
|
-
'totalRules',
|
|
3977
|
-
'rulesWithMatches',
|
|
3978
|
-
'totalMatches',
|
|
3979
|
-
'averageConfidence',
|
|
3980
|
-
'ruleStats'
|
|
3981
|
-
]
|
|
4534
|
+
required: ['data', 'total', 'limit', 'offset']
|
|
3982
4535
|
} as const;
|
|
3983
4536
|
|
|
3984
|
-
export const $
|
|
4537
|
+
export const $ValidateRuleDto = {
|
|
3985
4538
|
type: 'object',
|
|
3986
4539
|
properties: {
|
|
3987
4540
|
name: {
|
|
@@ -4030,7 +4583,8 @@ export const $UpdateTransactionRuleDto = {
|
|
|
4030
4583
|
},
|
|
4031
4584
|
matchLogic: {
|
|
4032
4585
|
type: 'string',
|
|
4033
|
-
enum: ['OR', 'AND']
|
|
4586
|
+
enum: ['OR', 'AND'],
|
|
4587
|
+
default: 'OR'
|
|
4034
4588
|
},
|
|
4035
4589
|
amountMin: {
|
|
4036
4590
|
type: 'number',
|
|
@@ -4044,13 +4598,10 @@ export const $UpdateTransactionRuleDto = {
|
|
|
4044
4598
|
},
|
|
4045
4599
|
priority: {
|
|
4046
4600
|
type: 'number',
|
|
4601
|
+
default: 50,
|
|
4047
4602
|
minimum: 0,
|
|
4048
4603
|
maximum: 1000
|
|
4049
4604
|
},
|
|
4050
|
-
enabled: {
|
|
4051
|
-
type: 'boolean',
|
|
4052
|
-
description: 'Enable or disable the rule'
|
|
4053
|
-
},
|
|
4054
4605
|
additionalTags: {
|
|
4055
4606
|
items: {
|
|
4056
4607
|
type: 'array'
|
|
@@ -4060,20 +4611,277 @@ export const $UpdateTransactionRuleDto = {
|
|
|
4060
4611
|
},
|
|
4061
4612
|
additionalMetadata: {
|
|
4062
4613
|
type: 'object'
|
|
4614
|
+
},
|
|
4615
|
+
upsertByPayee: {
|
|
4616
|
+
type: 'boolean',
|
|
4617
|
+
description:
|
|
4618
|
+
'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
|
|
4063
4619
|
}
|
|
4064
|
-
}
|
|
4620
|
+
},
|
|
4621
|
+
required: ['name', 'matchLogic', 'priority']
|
|
4065
4622
|
} as const;
|
|
4066
4623
|
|
|
4067
|
-
export const $
|
|
4624
|
+
export const $ValidateRuleResponseDto = {
|
|
4068
4625
|
type: 'object',
|
|
4069
4626
|
properties: {
|
|
4070
|
-
|
|
4071
|
-
type: '
|
|
4072
|
-
|
|
4073
|
-
|
|
4627
|
+
valid: {
|
|
4628
|
+
type: 'boolean',
|
|
4629
|
+
description: 'Whether the rule configuration is valid',
|
|
4630
|
+
example: true
|
|
4074
4631
|
},
|
|
4075
|
-
|
|
4076
|
-
|
|
4632
|
+
errors: {
|
|
4633
|
+
description: 'List of validation errors (empty if valid)',
|
|
4634
|
+
example: [],
|
|
4635
|
+
items: {
|
|
4636
|
+
type: 'array'
|
|
4637
|
+
},
|
|
4638
|
+
type: 'array'
|
|
4639
|
+
},
|
|
4640
|
+
warnings: {
|
|
4641
|
+
description: 'List of validation warnings (non-blocking issues)',
|
|
4642
|
+
example: [
|
|
4643
|
+
'No account constraints specified - rule will match any account'
|
|
4644
|
+
],
|
|
4645
|
+
items: {
|
|
4646
|
+
type: 'array'
|
|
4647
|
+
},
|
|
4648
|
+
type: 'array'
|
|
4649
|
+
}
|
|
4650
|
+
},
|
|
4651
|
+
required: ['valid', 'errors', 'warnings']
|
|
4652
|
+
} as const;
|
|
4653
|
+
|
|
4654
|
+
export const $BulkCreateRulesDto = {
|
|
4655
|
+
type: 'object',
|
|
4656
|
+
properties: {
|
|
4657
|
+
rules: {
|
|
4658
|
+
items: {
|
|
4659
|
+
type: 'array'
|
|
4660
|
+
},
|
|
4661
|
+
description: 'Array of rules to import',
|
|
4662
|
+
type: 'array'
|
|
4663
|
+
},
|
|
4664
|
+
conflictStrategy: {
|
|
4665
|
+
type: 'string',
|
|
4666
|
+
enum: ['replace', 'skip'],
|
|
4667
|
+
default: 'skip',
|
|
4668
|
+
description:
|
|
4669
|
+
'Conflict handling strategy: skip (default) ignores duplicates, replace soft-deletes existing rule'
|
|
4670
|
+
}
|
|
4671
|
+
},
|
|
4672
|
+
required: ['rules', 'conflictStrategy']
|
|
4673
|
+
} as const;
|
|
4674
|
+
|
|
4675
|
+
export const $BulkCreateRulesResponseDto = {
|
|
4676
|
+
type: 'object',
|
|
4677
|
+
properties: {
|
|
4678
|
+
successCount: {
|
|
4679
|
+
type: 'number',
|
|
4680
|
+
description: 'Number of successfully created rules'
|
|
4681
|
+
},
|
|
4682
|
+
failureCount: {
|
|
4683
|
+
type: 'number',
|
|
4684
|
+
description: 'Number of failed rules'
|
|
4685
|
+
},
|
|
4686
|
+
errors: {
|
|
4687
|
+
type: 'array',
|
|
4688
|
+
description: 'Error details for failed rules',
|
|
4689
|
+
items: {
|
|
4690
|
+
type: 'object',
|
|
4691
|
+
properties: {
|
|
4692
|
+
index: {
|
|
4693
|
+
type: 'number'
|
|
4694
|
+
},
|
|
4695
|
+
message: {
|
|
4696
|
+
type: 'string'
|
|
4697
|
+
}
|
|
4698
|
+
}
|
|
4699
|
+
}
|
|
4700
|
+
},
|
|
4701
|
+
createdRuleIds: {
|
|
4702
|
+
description: 'IDs of successfully created rules',
|
|
4703
|
+
type: 'array',
|
|
4704
|
+
items: {
|
|
4705
|
+
type: 'string'
|
|
4706
|
+
}
|
|
4707
|
+
}
|
|
4708
|
+
},
|
|
4709
|
+
required: ['successCount', 'failureCount', 'errors', 'createdRuleIds']
|
|
4710
|
+
} as const;
|
|
4711
|
+
|
|
4712
|
+
export const $ExportRulesResponseDto = {
|
|
4713
|
+
type: 'object',
|
|
4714
|
+
properties: {
|
|
4715
|
+
exportedAt: {
|
|
4716
|
+
type: 'string',
|
|
4717
|
+
description: 'Export timestamp'
|
|
4718
|
+
},
|
|
4719
|
+
userId: {
|
|
4720
|
+
type: 'string',
|
|
4721
|
+
description: 'User ID'
|
|
4722
|
+
},
|
|
4723
|
+
ruleCount: {
|
|
4724
|
+
type: 'number',
|
|
4725
|
+
description: 'Number of exported rules'
|
|
4726
|
+
},
|
|
4727
|
+
rules: {
|
|
4728
|
+
type: 'array',
|
|
4729
|
+
description: 'Exported rules'
|
|
4730
|
+
}
|
|
4731
|
+
},
|
|
4732
|
+
required: ['exportedAt', 'userId', 'ruleCount', 'rules']
|
|
4733
|
+
} as const;
|
|
4734
|
+
|
|
4735
|
+
export const $RuleStatisticsResponseDto = {
|
|
4736
|
+
type: 'object',
|
|
4737
|
+
properties: {
|
|
4738
|
+
period: {
|
|
4739
|
+
type: 'string',
|
|
4740
|
+
description: 'Statistics time period',
|
|
4741
|
+
enum: ['7d', '30d', '90d']
|
|
4742
|
+
},
|
|
4743
|
+
totalRules: {
|
|
4744
|
+
type: 'number',
|
|
4745
|
+
description: 'Total number of rules'
|
|
4746
|
+
},
|
|
4747
|
+
rulesWithMatches: {
|
|
4748
|
+
type: 'number',
|
|
4749
|
+
description: 'Number of rules with at least one match'
|
|
4750
|
+
},
|
|
4751
|
+
totalMatches: {
|
|
4752
|
+
type: 'number',
|
|
4753
|
+
description: 'Total number of matches across all rules'
|
|
4754
|
+
},
|
|
4755
|
+
averageConfidence: {
|
|
4756
|
+
type: 'number',
|
|
4757
|
+
description: 'Average confidence score across all matches',
|
|
4758
|
+
example: 0.82
|
|
4759
|
+
},
|
|
4760
|
+
ruleStats: {
|
|
4761
|
+
type: 'array',
|
|
4762
|
+
description: 'Per-rule statistics',
|
|
4763
|
+
items: {
|
|
4764
|
+
type: 'object',
|
|
4765
|
+
properties: {
|
|
4766
|
+
ruleId: {
|
|
4767
|
+
type: 'string'
|
|
4768
|
+
},
|
|
4769
|
+
ruleName: {
|
|
4770
|
+
type: 'string'
|
|
4771
|
+
},
|
|
4772
|
+
matchCount: {
|
|
4773
|
+
type: 'number'
|
|
4774
|
+
},
|
|
4775
|
+
averageConfidence: {
|
|
4776
|
+
type: 'number'
|
|
4777
|
+
}
|
|
4778
|
+
}
|
|
4779
|
+
}
|
|
4780
|
+
}
|
|
4781
|
+
},
|
|
4782
|
+
required: [
|
|
4783
|
+
'period',
|
|
4784
|
+
'totalRules',
|
|
4785
|
+
'rulesWithMatches',
|
|
4786
|
+
'totalMatches',
|
|
4787
|
+
'averageConfidence',
|
|
4788
|
+
'ruleStats'
|
|
4789
|
+
]
|
|
4790
|
+
} as const;
|
|
4791
|
+
|
|
4792
|
+
export const $UpdateTransactionRuleDto = {
|
|
4793
|
+
type: 'object',
|
|
4794
|
+
properties: {
|
|
4795
|
+
name: {
|
|
4796
|
+
type: 'string',
|
|
4797
|
+
minLength: 1,
|
|
4798
|
+
maxLength: 100
|
|
4799
|
+
},
|
|
4800
|
+
description: {
|
|
4801
|
+
type: 'string',
|
|
4802
|
+
maxLength: 500
|
|
4803
|
+
},
|
|
4804
|
+
narrationKeywords: {
|
|
4805
|
+
items: {
|
|
4806
|
+
type: 'array'
|
|
4807
|
+
},
|
|
4808
|
+
maxItems: 50,
|
|
4809
|
+
type: 'array'
|
|
4810
|
+
},
|
|
4811
|
+
payeeKeywords: {
|
|
4812
|
+
items: {
|
|
4813
|
+
type: 'array'
|
|
4814
|
+
},
|
|
4815
|
+
maxItems: 50,
|
|
4816
|
+
type: 'array'
|
|
4817
|
+
},
|
|
4818
|
+
categoryKeywords: {
|
|
4819
|
+
items: {
|
|
4820
|
+
type: 'array'
|
|
4821
|
+
},
|
|
4822
|
+
maxItems: 50,
|
|
4823
|
+
type: 'array'
|
|
4824
|
+
},
|
|
4825
|
+
methodKeywords: {
|
|
4826
|
+
items: {
|
|
4827
|
+
type: 'array'
|
|
4828
|
+
},
|
|
4829
|
+
maxItems: 50,
|
|
4830
|
+
description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
|
|
4831
|
+
type: 'array'
|
|
4832
|
+
},
|
|
4833
|
+
categoryAccount: {
|
|
4834
|
+
type: 'string',
|
|
4835
|
+
maxLength: 200,
|
|
4836
|
+
description:
|
|
4837
|
+
'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
|
|
4838
|
+
},
|
|
4839
|
+
matchLogic: {
|
|
4840
|
+
type: 'string',
|
|
4841
|
+
enum: ['OR', 'AND']
|
|
4842
|
+
},
|
|
4843
|
+
amountMin: {
|
|
4844
|
+
type: 'number',
|
|
4845
|
+
minimum: 0,
|
|
4846
|
+
description: 'Minimum transaction amount (inclusive)'
|
|
4847
|
+
},
|
|
4848
|
+
amountMax: {
|
|
4849
|
+
type: 'number',
|
|
4850
|
+
minimum: 0,
|
|
4851
|
+
description: 'Maximum transaction amount (inclusive)'
|
|
4852
|
+
},
|
|
4853
|
+
priority: {
|
|
4854
|
+
type: 'number',
|
|
4855
|
+
minimum: 0,
|
|
4856
|
+
maximum: 1000
|
|
4857
|
+
},
|
|
4858
|
+
enabled: {
|
|
4859
|
+
type: 'boolean',
|
|
4860
|
+
description: 'Enable or disable the rule'
|
|
4861
|
+
},
|
|
4862
|
+
additionalTags: {
|
|
4863
|
+
items: {
|
|
4864
|
+
type: 'array'
|
|
4865
|
+
},
|
|
4866
|
+
maxItems: 20,
|
|
4867
|
+
type: 'array'
|
|
4868
|
+
},
|
|
4869
|
+
additionalMetadata: {
|
|
4870
|
+
type: 'object'
|
|
4871
|
+
}
|
|
4872
|
+
}
|
|
4873
|
+
} as const;
|
|
4874
|
+
|
|
4875
|
+
export const $TestRuleDto = {
|
|
4876
|
+
type: 'object',
|
|
4877
|
+
properties: {
|
|
4878
|
+
narration: {
|
|
4879
|
+
type: 'string',
|
|
4880
|
+
minLength: 1,
|
|
4881
|
+
maxLength: 500
|
|
4882
|
+
},
|
|
4883
|
+
payee: {
|
|
4884
|
+
type: 'string',
|
|
4077
4885
|
maxLength: 200
|
|
4078
4886
|
},
|
|
4079
4887
|
categoryAccount: {
|
|
@@ -4120,151 +4928,393 @@ export const $TestRuleResponseDto = {
|
|
|
4120
4928
|
required: ['ruleId', 'matches', 'confidence', 'matchDetails']
|
|
4121
4929
|
} as const;
|
|
4122
4930
|
|
|
4123
|
-
export const $
|
|
4931
|
+
export const $CreateBeanEventDto = {
|
|
4124
4932
|
type: 'object',
|
|
4125
4933
|
properties: {
|
|
4126
|
-
|
|
4934
|
+
date: {
|
|
4127
4935
|
type: 'string',
|
|
4128
|
-
description: '
|
|
4129
|
-
example: '
|
|
4936
|
+
description: 'Life event date (ISO 8601)',
|
|
4937
|
+
example: '2024-03-15'
|
|
4938
|
+
},
|
|
4939
|
+
type: {
|
|
4940
|
+
type: 'string',
|
|
4941
|
+
description:
|
|
4942
|
+
'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
|
|
4943
|
+
example: 'employer'
|
|
4944
|
+
},
|
|
4945
|
+
description: {
|
|
4946
|
+
type: 'string',
|
|
4947
|
+
description:
|
|
4948
|
+
'Life event description. Empty string is a VALID value (distinct from absence).',
|
|
4949
|
+
example: 'Acme Corp'
|
|
4950
|
+
},
|
|
4951
|
+
meta: {
|
|
4952
|
+
type: 'object',
|
|
4953
|
+
description:
|
|
4954
|
+
'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
|
|
4955
|
+
example: {
|
|
4956
|
+
note: 'Promotion'
|
|
4957
|
+
}
|
|
4958
|
+
}
|
|
4959
|
+
},
|
|
4960
|
+
required: ['date', 'type', 'description']
|
|
4961
|
+
} as const;
|
|
4962
|
+
|
|
4963
|
+
export const $EventResponseDto = {
|
|
4964
|
+
type: 'object',
|
|
4965
|
+
properties: {
|
|
4966
|
+
id: {
|
|
4967
|
+
type: 'string',
|
|
4968
|
+
description: 'Unique identifier',
|
|
4969
|
+
example: 'uuid-123-456'
|
|
4970
|
+
},
|
|
4971
|
+
userId: {
|
|
4972
|
+
type: 'string',
|
|
4973
|
+
description: 'User ID (owner of the life event)',
|
|
4974
|
+
example: 'user-123'
|
|
4975
|
+
},
|
|
4976
|
+
date: {
|
|
4977
|
+
type: 'string',
|
|
4978
|
+
description: 'Life event date (ISO 8601 format)',
|
|
4979
|
+
example: '2024-03-15',
|
|
4980
|
+
format: 'date'
|
|
4981
|
+
},
|
|
4982
|
+
type: {
|
|
4983
|
+
type: 'string',
|
|
4984
|
+
description:
|
|
4985
|
+
'Life event type (user-defined, e.g., "employer", "location")',
|
|
4986
|
+
example: 'employer'
|
|
4987
|
+
},
|
|
4988
|
+
description: {
|
|
4989
|
+
type: 'string',
|
|
4990
|
+
description:
|
|
4991
|
+
'Life event description. May be an empty string (a valid value distinct from absence).',
|
|
4992
|
+
example: 'Acme Corp'
|
|
4993
|
+
},
|
|
4994
|
+
meta: {
|
|
4995
|
+
type: 'object',
|
|
4996
|
+
description: 'Product-side metadata (free-form JSON)',
|
|
4997
|
+
example: {
|
|
4998
|
+
note: 'Promotion'
|
|
4999
|
+
}
|
|
5000
|
+
},
|
|
5001
|
+
createdAt: {
|
|
5002
|
+
format: 'date-time',
|
|
5003
|
+
type: 'string',
|
|
5004
|
+
description: 'Creation timestamp',
|
|
5005
|
+
example: '2024-03-15T10:00:00Z'
|
|
5006
|
+
},
|
|
5007
|
+
updatedAt: {
|
|
5008
|
+
format: 'date-time',
|
|
5009
|
+
type: 'string',
|
|
5010
|
+
description:
|
|
5011
|
+
'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
|
|
5012
|
+
example: '2024-03-15T10:00:00Z'
|
|
5013
|
+
}
|
|
5014
|
+
},
|
|
5015
|
+
required: [
|
|
5016
|
+
'id',
|
|
5017
|
+
'userId',
|
|
5018
|
+
'date',
|
|
5019
|
+
'type',
|
|
5020
|
+
'description',
|
|
5021
|
+
'meta',
|
|
5022
|
+
'createdAt',
|
|
5023
|
+
'updatedAt'
|
|
5024
|
+
]
|
|
5025
|
+
} as const;
|
|
5026
|
+
|
|
5027
|
+
export const $EventListResponseDto = {
|
|
5028
|
+
type: 'object',
|
|
5029
|
+
properties: {
|
|
5030
|
+
items: {
|
|
5031
|
+
description: 'List of life events',
|
|
5032
|
+
type: 'array',
|
|
5033
|
+
items: {
|
|
5034
|
+
$ref: '#/components/schemas/EventResponseDto'
|
|
5035
|
+
}
|
|
5036
|
+
},
|
|
5037
|
+
total: {
|
|
5038
|
+
type: 'number',
|
|
5039
|
+
description: 'Total number of life events matching the query',
|
|
5040
|
+
example: 42
|
|
5041
|
+
}
|
|
5042
|
+
},
|
|
5043
|
+
required: ['items', 'total']
|
|
5044
|
+
} as const;
|
|
5045
|
+
|
|
5046
|
+
export const $UpdateBeanEventDto = {
|
|
5047
|
+
type: 'object',
|
|
5048
|
+
properties: {
|
|
5049
|
+
date: {
|
|
5050
|
+
type: 'string',
|
|
5051
|
+
description: 'Life event date (ISO 8601)'
|
|
5052
|
+
},
|
|
5053
|
+
type: {
|
|
5054
|
+
type: 'string',
|
|
5055
|
+
description: 'Life event type (user-defined)'
|
|
5056
|
+
},
|
|
5057
|
+
description: {
|
|
5058
|
+
type: 'string',
|
|
5059
|
+
description:
|
|
5060
|
+
'Life event description. Empty string is a VALID value (distinct from absence).'
|
|
5061
|
+
},
|
|
5062
|
+
meta: {
|
|
5063
|
+
type: 'object',
|
|
5064
|
+
description: 'Product-side metadata (free-form JSON)'
|
|
5065
|
+
}
|
|
5066
|
+
}
|
|
5067
|
+
} as const;
|
|
5068
|
+
|
|
5069
|
+
export const $OnboardingAccountDto = {
|
|
5070
|
+
type: 'object',
|
|
5071
|
+
properties: {
|
|
5072
|
+
path: {
|
|
5073
|
+
type: 'string',
|
|
5074
|
+
description:
|
|
5075
|
+
'Account path (Assets/Liabilities only; format validated by the account service)',
|
|
5076
|
+
example: 'Assets:Checking'
|
|
5077
|
+
},
|
|
5078
|
+
currency: {
|
|
5079
|
+
type: 'string',
|
|
5080
|
+
description: 'ISO 4217 currency code (3 letters)',
|
|
5081
|
+
example: 'USD'
|
|
5082
|
+
},
|
|
5083
|
+
openingBalance: {
|
|
5084
|
+
type: 'string',
|
|
5085
|
+
description:
|
|
5086
|
+
'Opening balance as a non-negative Decimal string (e.g. "1000.00")',
|
|
5087
|
+
example: '1000.00'
|
|
5088
|
+
},
|
|
5089
|
+
platformId: {
|
|
5090
|
+
type: 'string',
|
|
5091
|
+
description:
|
|
5092
|
+
'Platform ID to bind the account to (references Platform.id); omit for unbound',
|
|
5093
|
+
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
5094
|
+
}
|
|
5095
|
+
},
|
|
5096
|
+
required: ['path', 'currency']
|
|
5097
|
+
} as const;
|
|
5098
|
+
|
|
5099
|
+
export const $OnboardingDto = {
|
|
5100
|
+
type: 'object',
|
|
5101
|
+
properties: {
|
|
5102
|
+
accounts: {
|
|
5103
|
+
description: 'Asset/Liability accounts to register with opening balances',
|
|
5104
|
+
type: 'array',
|
|
5105
|
+
items: {
|
|
5106
|
+
$ref: '#/components/schemas/OnboardingAccountDto'
|
|
5107
|
+
}
|
|
5108
|
+
},
|
|
5109
|
+
skipAssetRegistration: {
|
|
5110
|
+
type: 'boolean',
|
|
5111
|
+
description:
|
|
5112
|
+
'Skip asset registration; only bootstrap the core account set',
|
|
5113
|
+
default: false
|
|
5114
|
+
}
|
|
5115
|
+
}
|
|
5116
|
+
} as const;
|
|
5117
|
+
|
|
5118
|
+
export const $ActualBalanceDto = {
|
|
5119
|
+
type: 'object',
|
|
5120
|
+
properties: {
|
|
5121
|
+
amount: {
|
|
5122
|
+
type: 'string',
|
|
5123
|
+
description:
|
|
5124
|
+
'Actual balance amount as a decimal string (preserves precision for tolerance inference).',
|
|
5125
|
+
example: '1234.56'
|
|
5126
|
+
},
|
|
5127
|
+
ccy: {
|
|
5128
|
+
type: 'string',
|
|
5129
|
+
description: 'Currency code (ISO 4217 or commodity ticker).',
|
|
5130
|
+
example: 'CNY'
|
|
5131
|
+
}
|
|
5132
|
+
},
|
|
5133
|
+
required: ['amount', 'ccy']
|
|
5134
|
+
} as const;
|
|
5135
|
+
|
|
5136
|
+
export const $ComputeReconciliationDto = {
|
|
5137
|
+
type: 'object',
|
|
5138
|
+
properties: {
|
|
5139
|
+
accountId: {
|
|
5140
|
+
type: 'string',
|
|
5141
|
+
description: 'BeanAccount id to reconcile.'
|
|
5142
|
+
},
|
|
5143
|
+
asOfDate: {
|
|
5144
|
+
type: 'string',
|
|
5145
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5146
|
+
example: '2026-07-24'
|
|
5147
|
+
},
|
|
5148
|
+
actualBalance: {
|
|
5149
|
+
description: 'Actual balance from the external statement.',
|
|
5150
|
+
allOf: [
|
|
5151
|
+
{
|
|
5152
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5153
|
+
}
|
|
5154
|
+
]
|
|
5155
|
+
}
|
|
5156
|
+
},
|
|
5157
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5158
|
+
} as const;
|
|
5159
|
+
|
|
5160
|
+
export const $ReconciliationComputeResultDto = {
|
|
5161
|
+
type: 'object',
|
|
5162
|
+
properties: {
|
|
5163
|
+
accountId: {
|
|
5164
|
+
type: 'string'
|
|
5165
|
+
},
|
|
5166
|
+
asOfDate: {
|
|
5167
|
+
type: 'string'
|
|
5168
|
+
},
|
|
5169
|
+
bookBalance: {
|
|
5170
|
+
type: 'string',
|
|
5171
|
+
description: 'System-computed book balance (decimal string).'
|
|
5172
|
+
},
|
|
5173
|
+
actualBalance: {
|
|
5174
|
+
type: 'string',
|
|
5175
|
+
description: 'User-entered actual balance (decimal string).'
|
|
5176
|
+
},
|
|
5177
|
+
currency: {
|
|
5178
|
+
type: 'string'
|
|
5179
|
+
},
|
|
5180
|
+
diff: {
|
|
5181
|
+
type: 'string',
|
|
5182
|
+
description: 'Diff = book − actual (decimal string).'
|
|
5183
|
+
},
|
|
5184
|
+
tolerance: {
|
|
5185
|
+
type: 'string',
|
|
5186
|
+
description: 'Applied tolerance (decimal string).'
|
|
5187
|
+
},
|
|
5188
|
+
withinTolerance: {
|
|
5189
|
+
type: 'boolean',
|
|
5190
|
+
description: 'true when |diff| ≤ tolerance.'
|
|
5191
|
+
},
|
|
5192
|
+
suggestedAction: {
|
|
5193
|
+
type: 'string',
|
|
5194
|
+
enum: ['assert', 'pad'],
|
|
5195
|
+
description:
|
|
5196
|
+
'Suggested next action: assert when within tolerance, pad otherwise.'
|
|
4130
5197
|
}
|
|
4131
5198
|
},
|
|
4132
|
-
required: [
|
|
5199
|
+
required: [
|
|
5200
|
+
'accountId',
|
|
5201
|
+
'asOfDate',
|
|
5202
|
+
'bookBalance',
|
|
5203
|
+
'actualBalance',
|
|
5204
|
+
'currency',
|
|
5205
|
+
'diff',
|
|
5206
|
+
'tolerance',
|
|
5207
|
+
'withinTolerance',
|
|
5208
|
+
'suggestedAction'
|
|
5209
|
+
]
|
|
4133
5210
|
} as const;
|
|
4134
5211
|
|
|
4135
|
-
export const $
|
|
5212
|
+
export const $AssertReconciliationDto = {
|
|
4136
5213
|
type: 'object',
|
|
4137
5214
|
properties: {
|
|
4138
|
-
|
|
5215
|
+
accountId: {
|
|
5216
|
+
type: 'string',
|
|
5217
|
+
description: 'BeanAccount id to reconcile.'
|
|
5218
|
+
},
|
|
5219
|
+
asOfDate: {
|
|
5220
|
+
type: 'string',
|
|
5221
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5222
|
+
example: '2026-07-24'
|
|
5223
|
+
},
|
|
5224
|
+
actualBalance: {
|
|
5225
|
+
description: 'Actual balance from the external statement.',
|
|
5226
|
+
allOf: [
|
|
5227
|
+
{
|
|
5228
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5229
|
+
}
|
|
5230
|
+
]
|
|
5231
|
+
},
|
|
5232
|
+
tolerance: {
|
|
4139
5233
|
type: 'string',
|
|
4140
5234
|
description:
|
|
4141
|
-
'
|
|
4142
|
-
example: '0.
|
|
5235
|
+
'Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).',
|
|
5236
|
+
example: '0.01'
|
|
4143
5237
|
}
|
|
4144
|
-
}
|
|
5238
|
+
},
|
|
5239
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
4145
5240
|
} as const;
|
|
4146
5241
|
|
|
4147
|
-
export const $
|
|
5242
|
+
export const $ReconciliationRecordDto = {
|
|
4148
5243
|
type: 'object',
|
|
4149
5244
|
properties: {
|
|
4150
|
-
|
|
4151
|
-
type: '
|
|
4152
|
-
description: 'Security ID'
|
|
4153
|
-
},
|
|
4154
|
-
annualInterestRate: {
|
|
4155
|
-
type: 'number',
|
|
4156
|
-
description: 'Annual interest rate',
|
|
4157
|
-
example: 0.05
|
|
4158
|
-
},
|
|
4159
|
-
currency: {
|
|
4160
|
-
type: 'string',
|
|
4161
|
-
description: 'Currency code',
|
|
4162
|
-
example: 'USD'
|
|
4163
|
-
},
|
|
4164
|
-
baseCurrency: {
|
|
4165
|
-
type: 'string',
|
|
4166
|
-
description: 'Base currency code',
|
|
4167
|
-
example: 'USD'
|
|
5245
|
+
id: {
|
|
5246
|
+
type: 'string'
|
|
4168
5247
|
},
|
|
4169
|
-
|
|
4170
|
-
type: 'string'
|
|
4171
|
-
description: 'Benchmark symbol',
|
|
4172
|
-
example: 'SPY'
|
|
5248
|
+
accountId: {
|
|
5249
|
+
type: 'string'
|
|
4173
5250
|
},
|
|
4174
|
-
|
|
4175
|
-
type: 'string'
|
|
4176
|
-
description: 'Color scheme',
|
|
4177
|
-
enum: ['DARK', 'LIGHT']
|
|
5251
|
+
date: {
|
|
5252
|
+
type: 'string'
|
|
4178
5253
|
},
|
|
4179
|
-
|
|
5254
|
+
amount: {
|
|
4180
5255
|
type: 'string',
|
|
4181
|
-
description: '
|
|
4182
|
-
example: '1y'
|
|
4183
|
-
},
|
|
4184
|
-
emergencyFund: {
|
|
4185
|
-
type: 'number',
|
|
4186
|
-
description: 'Emergency fund amount',
|
|
4187
|
-
example: 10000
|
|
5256
|
+
description: 'Asserted (actual) amount.'
|
|
4188
5257
|
},
|
|
4189
|
-
|
|
4190
|
-
|
|
4191
|
-
type: 'array',
|
|
4192
|
-
items: {
|
|
4193
|
-
type: 'string'
|
|
4194
|
-
}
|
|
4195
|
-
},
|
|
4196
|
-
'filters.assetClasses': {
|
|
4197
|
-
description: 'Asset class filters',
|
|
4198
|
-
type: 'array',
|
|
4199
|
-
items: {
|
|
4200
|
-
type: 'string'
|
|
4201
|
-
}
|
|
5258
|
+
currency: {
|
|
5259
|
+
type: 'string'
|
|
4202
5260
|
},
|
|
4203
|
-
|
|
4204
|
-
type: 'string'
|
|
4205
|
-
description: 'Data source filter'
|
|
5261
|
+
tolerance: {
|
|
5262
|
+
type: 'string'
|
|
4206
5263
|
},
|
|
4207
|
-
|
|
5264
|
+
diffAmount: {
|
|
4208
5265
|
type: 'string',
|
|
4209
|
-
description: '
|
|
4210
|
-
},
|
|
4211
|
-
'filters.tags': {
|
|
4212
|
-
description: 'Tag filters',
|
|
4213
|
-
type: 'array',
|
|
4214
|
-
items: {
|
|
4215
|
-
type: 'string'
|
|
4216
|
-
}
|
|
4217
|
-
},
|
|
4218
|
-
isExperimentalFeatures: {
|
|
4219
|
-
type: 'boolean',
|
|
4220
|
-
description: 'Enable experimental features'
|
|
5266
|
+
description: 'book − actual.'
|
|
4221
5267
|
},
|
|
4222
|
-
|
|
4223
|
-
type: '
|
|
4224
|
-
description: 'Enable restricted view mode'
|
|
4225
|
-
},
|
|
4226
|
-
language: {
|
|
4227
|
-
type: 'string',
|
|
4228
|
-
description: 'Language code',
|
|
4229
|
-
example: 'en'
|
|
5268
|
+
diffCurrency: {
|
|
5269
|
+
type: 'string'
|
|
4230
5270
|
},
|
|
4231
|
-
|
|
5271
|
+
createdAt: {
|
|
5272
|
+
type: 'string'
|
|
5273
|
+
}
|
|
5274
|
+
},
|
|
5275
|
+
required: ['id', 'accountId', 'date', 'amount', 'currency', 'createdAt']
|
|
5276
|
+
} as const;
|
|
5277
|
+
|
|
5278
|
+
export const $PadReconciliationDto = {
|
|
5279
|
+
type: 'object',
|
|
5280
|
+
properties: {
|
|
5281
|
+
accountId: {
|
|
4232
5282
|
type: 'string',
|
|
4233
|
-
description: '
|
|
4234
|
-
example: 'en-US'
|
|
4235
|
-
},
|
|
4236
|
-
projectedTotalAmount: {
|
|
4237
|
-
type: 'number',
|
|
4238
|
-
description: 'Projected total amount',
|
|
4239
|
-
example: 1000000
|
|
5283
|
+
description: 'BeanAccount id to reconcile.'
|
|
4240
5284
|
},
|
|
4241
|
-
|
|
5285
|
+
asOfDate: {
|
|
4242
5286
|
type: 'string',
|
|
4243
|
-
description: '
|
|
4244
|
-
example: '
|
|
5287
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5288
|
+
example: '2026-07-24'
|
|
4245
5289
|
},
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
5290
|
+
actualBalance: {
|
|
5291
|
+
description: 'Actual balance from the external statement.',
|
|
5292
|
+
allOf: [
|
|
5293
|
+
{
|
|
5294
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5295
|
+
}
|
|
5296
|
+
]
|
|
4250
5297
|
},
|
|
4251
|
-
|
|
5298
|
+
sourceAccount: {
|
|
4252
5299
|
type: 'string',
|
|
4253
|
-
description:
|
|
4254
|
-
|
|
5300
|
+
description:
|
|
5301
|
+
'Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).',
|
|
5302
|
+
example: 'Equity:Opening-Balances',
|
|
5303
|
+
default: 'Equity:Opening-Balances'
|
|
4255
5304
|
}
|
|
4256
|
-
}
|
|
5305
|
+
},
|
|
5306
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
4257
5307
|
} as const;
|
|
4258
5308
|
|
|
4259
|
-
export const $
|
|
5309
|
+
export const $PadResultDto = {
|
|
4260
5310
|
type: 'object',
|
|
4261
5311
|
properties: {
|
|
4262
|
-
|
|
5312
|
+
transactionId: {
|
|
4263
5313
|
type: 'string',
|
|
4264
|
-
description: '
|
|
5314
|
+
description: 'Created pad adjusting transaction id.'
|
|
4265
5315
|
}
|
|
4266
5316
|
},
|
|
4267
|
-
required: ['
|
|
5317
|
+
required: ['transactionId']
|
|
4268
5318
|
} as const;
|
|
4269
5319
|
|
|
4270
5320
|
export const $FileImportDto = {
|
|
@@ -4433,7 +5483,7 @@ export const $IdentifyResultDto = {
|
|
|
4433
5483
|
account: {
|
|
4434
5484
|
type: 'string',
|
|
4435
5485
|
description: 'Default account used by this importer',
|
|
4436
|
-
example: 'Assets:Alipay:Balance'
|
|
5486
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4437
5487
|
},
|
|
4438
5488
|
message: {
|
|
4439
5489
|
type: 'string',
|
|
@@ -4450,7 +5500,7 @@ export const $MapperDefaultsDto = {
|
|
|
4450
5500
|
sourceAccount: {
|
|
4451
5501
|
type: 'string',
|
|
4452
5502
|
description: 'Source account for transactions (Beancount format)',
|
|
4453
|
-
example: 'Assets:Alipay:Balance'
|
|
5503
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4454
5504
|
},
|
|
4455
5505
|
currency: {
|
|
4456
5506
|
type: 'string',
|
|
@@ -4487,7 +5537,7 @@ export const $MapperDefaultsDto = {
|
|
|
4487
5537
|
description:
|
|
4488
5538
|
'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
|
|
4489
5539
|
example: {
|
|
4490
|
-
HuaBei: 'Liabilities:
|
|
5540
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4491
5541
|
CreditCard: 'Liabilities:CreditCard'
|
|
4492
5542
|
}
|
|
4493
5543
|
}
|
|
@@ -4619,7 +5669,7 @@ export const $UpdateMapperDefaultsDto = {
|
|
|
4619
5669
|
sourceAccount: {
|
|
4620
5670
|
type: 'string',
|
|
4621
5671
|
description: 'Source account for transactions (Beancount format)',
|
|
4622
|
-
example: 'Assets:Alipay:Balance',
|
|
5672
|
+
example: 'Assets:CN:Alipay:Balance',
|
|
4623
5673
|
pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
|
|
4624
5674
|
},
|
|
4625
5675
|
currency: {
|
|
@@ -4647,7 +5697,7 @@ export const $UpdateMapperDefaultsDto = {
|
|
|
4647
5697
|
description:
|
|
4648
5698
|
'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
|
|
4649
5699
|
example: {
|
|
4650
|
-
HuaBei: 'Liabilities:
|
|
5700
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4651
5701
|
CreditCard: 'Liabilities:CreditCard'
|
|
4652
5702
|
}
|
|
4653
5703
|
}
|
|
@@ -4675,115 +5725,9 @@ export const $UpdateImporterConfigDto = {
|
|
|
4675
5725
|
description: 'Configuration data (v1 schema)',
|
|
4676
5726
|
allOf: [
|
|
4677
5727
|
{
|
|
4678
|
-
$ref: '#/components/schemas/UpdateConfigDataDto'
|
|
4679
|
-
}
|
|
4680
|
-
]
|
|
4681
|
-
}
|
|
4682
|
-
}
|
|
4683
|
-
} as const;
|
|
4684
|
-
|
|
4685
|
-
export const $CreatePlatformDto = {
|
|
4686
|
-
type: 'object',
|
|
4687
|
-
properties: {
|
|
4688
|
-
name: {
|
|
4689
|
-
type: 'string',
|
|
4690
|
-
description: 'Platform name',
|
|
4691
|
-
example: 'Binance'
|
|
4692
|
-
},
|
|
4693
|
-
canonical: {
|
|
4694
|
-
type: 'string',
|
|
4695
|
-
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
4696
|
-
example: 'binance'
|
|
4697
|
-
},
|
|
4698
|
-
aliases: {
|
|
4699
|
-
description: 'Platform aliases (multi-language names for lookup)',
|
|
4700
|
-
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
4701
|
-
type: 'array',
|
|
4702
|
-
items: {
|
|
4703
|
-
type: 'string'
|
|
4704
|
-
}
|
|
4705
|
-
},
|
|
4706
|
-
url: {
|
|
4707
|
-
type: 'string',
|
|
4708
|
-
description: 'Platform URL',
|
|
4709
|
-
example: 'https://www.binance.com'
|
|
4710
|
-
},
|
|
4711
|
-
type: {
|
|
4712
|
-
type: 'string',
|
|
4713
|
-
description: 'Platform type',
|
|
4714
|
-
enum: [
|
|
4715
|
-
'BANK',
|
|
4716
|
-
'BROKERAGE',
|
|
4717
|
-
'CRYPTO_EXCHANGE',
|
|
4718
|
-
'PAYMENT',
|
|
4719
|
-
'INVESTMENT',
|
|
4720
|
-
'INSURANCE',
|
|
4721
|
-
'OTHER'
|
|
4722
|
-
],
|
|
4723
|
-
example: 'CRYPTO_EXCHANGE'
|
|
4724
|
-
},
|
|
4725
|
-
logoUrl: {
|
|
4726
|
-
type: 'string',
|
|
4727
|
-
description: 'Platform logo URL',
|
|
4728
|
-
example: 'https://example.com/logos/binance.png'
|
|
4729
|
-
},
|
|
4730
|
-
isActive: {
|
|
4731
|
-
type: 'boolean',
|
|
4732
|
-
description: 'Whether the platform is active',
|
|
4733
|
-
default: true
|
|
4734
|
-
}
|
|
4735
|
-
},
|
|
4736
|
-
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
4737
|
-
} as const;
|
|
4738
|
-
|
|
4739
|
-
export const $UpdatePlatformDto = {
|
|
4740
|
-
type: 'object',
|
|
4741
|
-
properties: {
|
|
4742
|
-
name: {
|
|
4743
|
-
type: 'string',
|
|
4744
|
-
description: 'Platform name',
|
|
4745
|
-
example: 'Binance'
|
|
4746
|
-
},
|
|
4747
|
-
canonical: {
|
|
4748
|
-
type: 'string',
|
|
4749
|
-
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
4750
|
-
example: 'binance'
|
|
4751
|
-
},
|
|
4752
|
-
aliases: {
|
|
4753
|
-
description: 'Platform aliases (multi-language names for lookup)',
|
|
4754
|
-
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
4755
|
-
type: 'array',
|
|
4756
|
-
items: {
|
|
4757
|
-
type: 'string'
|
|
4758
|
-
}
|
|
4759
|
-
},
|
|
4760
|
-
url: {
|
|
4761
|
-
type: 'string',
|
|
4762
|
-
description: 'Platform URL',
|
|
4763
|
-
example: 'https://www.binance.com'
|
|
4764
|
-
},
|
|
4765
|
-
type: {
|
|
4766
|
-
type: 'string',
|
|
4767
|
-
description: 'Platform type',
|
|
4768
|
-
enum: [
|
|
4769
|
-
'BANK',
|
|
4770
|
-
'BROKERAGE',
|
|
4771
|
-
'CRYPTO_EXCHANGE',
|
|
4772
|
-
'PAYMENT',
|
|
4773
|
-
'INVESTMENT',
|
|
4774
|
-
'INSURANCE',
|
|
4775
|
-
'OTHER'
|
|
4776
|
-
],
|
|
4777
|
-
example: 'CRYPTO_EXCHANGE'
|
|
4778
|
-
},
|
|
4779
|
-
logoUrl: {
|
|
4780
|
-
type: 'string',
|
|
4781
|
-
description: 'Platform logo URL',
|
|
4782
|
-
example: 'https://example.com/logos/binance.png'
|
|
4783
|
-
},
|
|
4784
|
-
isActive: {
|
|
4785
|
-
type: 'boolean',
|
|
4786
|
-
description: 'Whether the platform is active'
|
|
5728
|
+
$ref: '#/components/schemas/UpdateConfigDataDto'
|
|
5729
|
+
}
|
|
5730
|
+
]
|
|
4787
5731
|
}
|
|
4788
5732
|
}
|
|
4789
5733
|
} as const;
|
|
@@ -4794,7 +5738,7 @@ export const $ProviderSyncConfigDto = {
|
|
|
4794
5738
|
sourceAccount: {
|
|
4795
5739
|
type: 'string',
|
|
4796
5740
|
description: 'Source account for the first posting',
|
|
4797
|
-
example: 'Assets:
|
|
5741
|
+
example: 'Assets:US:Chase:Checking'
|
|
4798
5742
|
},
|
|
4799
5743
|
defaultCurrency: {
|
|
4800
5744
|
type: 'string',
|
|
@@ -4803,26 +5747,29 @@ export const $ProviderSyncConfigDto = {
|
|
|
4803
5747
|
},
|
|
4804
5748
|
defaultExpenseAccount: {
|
|
4805
5749
|
type: 'string',
|
|
4806
|
-
description:
|
|
5750
|
+
description:
|
|
5751
|
+
'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
|
|
4807
5752
|
example: 'Expenses:Unknown'
|
|
4808
5753
|
},
|
|
4809
5754
|
defaultIncomeAccount: {
|
|
4810
5755
|
type: 'string',
|
|
4811
|
-
description:
|
|
5756
|
+
description:
|
|
5757
|
+
'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
|
|
4812
5758
|
example: 'Income:Unknown'
|
|
4813
5759
|
},
|
|
4814
5760
|
filterPending: {
|
|
4815
5761
|
type: 'boolean',
|
|
4816
5762
|
description: 'Filter pending transactions',
|
|
4817
5763
|
default: true
|
|
5764
|
+
},
|
|
5765
|
+
externalAccountId: {
|
|
5766
|
+
type: 'string',
|
|
5767
|
+
description:
|
|
5768
|
+
'External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.',
|
|
5769
|
+
example: 'acc_gocardless_001'
|
|
4818
5770
|
}
|
|
4819
5771
|
},
|
|
4820
|
-
required: [
|
|
4821
|
-
'sourceAccount',
|
|
4822
|
-
'defaultCurrency',
|
|
4823
|
-
'defaultExpenseAccount',
|
|
4824
|
-
'defaultIncomeAccount'
|
|
4825
|
-
]
|
|
5772
|
+
required: ['sourceAccount', 'defaultCurrency']
|
|
4826
5773
|
} as const;
|
|
4827
5774
|
|
|
4828
5775
|
export const $ProviderSyncDto = {
|
|
@@ -4934,6 +5881,94 @@ export const $SupportedProvidersResponseDto = {
|
|
|
4934
5881
|
required: ['providers']
|
|
4935
5882
|
} as const;
|
|
4936
5883
|
|
|
5884
|
+
export const $CreateExternalAccountLinkDto = {
|
|
5885
|
+
type: 'object',
|
|
5886
|
+
properties: {
|
|
5887
|
+
provider: {
|
|
5888
|
+
type: 'string',
|
|
5889
|
+
enum: [
|
|
5890
|
+
'plaid',
|
|
5891
|
+
'teller',
|
|
5892
|
+
'truelayer',
|
|
5893
|
+
'gocardless',
|
|
5894
|
+
'simplefin',
|
|
5895
|
+
'yodlee',
|
|
5896
|
+
'beancount-direct',
|
|
5897
|
+
'parsed-bill'
|
|
5898
|
+
],
|
|
5899
|
+
example: 'plaid',
|
|
5900
|
+
description: 'Open Banking provider (whitelist)'
|
|
5901
|
+
},
|
|
5902
|
+
externalAccountId: {
|
|
5903
|
+
type: 'string',
|
|
5904
|
+
example: 'acc-plaid-001',
|
|
5905
|
+
description: 'External account ID from the provider'
|
|
5906
|
+
},
|
|
5907
|
+
beanAccountId: {
|
|
5908
|
+
type: 'string',
|
|
5909
|
+
example: '550e8400-e29b-41d4-a716-446655440000',
|
|
5910
|
+
description: 'Target BeanAccount ID (must belong to the JWT user)'
|
|
5911
|
+
}
|
|
5912
|
+
},
|
|
5913
|
+
required: ['provider', 'externalAccountId', 'beanAccountId']
|
|
5914
|
+
} as const;
|
|
5915
|
+
|
|
5916
|
+
export const $ExternalAccountLinkResponseDto = {
|
|
5917
|
+
type: 'object',
|
|
5918
|
+
properties: {
|
|
5919
|
+
id: {
|
|
5920
|
+
type: 'string'
|
|
5921
|
+
},
|
|
5922
|
+
provider: {
|
|
5923
|
+
type: 'string'
|
|
5924
|
+
},
|
|
5925
|
+
externalAccountId: {
|
|
5926
|
+
type: 'string'
|
|
5927
|
+
},
|
|
5928
|
+
beanAccountId: {
|
|
5929
|
+
type: 'string'
|
|
5930
|
+
},
|
|
5931
|
+
isActive: {
|
|
5932
|
+
type: 'boolean'
|
|
5933
|
+
},
|
|
5934
|
+
createdAt: {
|
|
5935
|
+
type: 'string'
|
|
5936
|
+
},
|
|
5937
|
+
updatedAt: {
|
|
5938
|
+
type: 'string'
|
|
5939
|
+
}
|
|
5940
|
+
},
|
|
5941
|
+
required: [
|
|
5942
|
+
'id',
|
|
5943
|
+
'provider',
|
|
5944
|
+
'externalAccountId',
|
|
5945
|
+
'beanAccountId',
|
|
5946
|
+
'isActive',
|
|
5947
|
+
'createdAt',
|
|
5948
|
+
'updatedAt'
|
|
5949
|
+
]
|
|
5950
|
+
} as const;
|
|
5951
|
+
|
|
5952
|
+
export const $ExternalAccountLinkListResponseDto = {
|
|
5953
|
+
type: 'object',
|
|
5954
|
+
properties: {
|
|
5955
|
+
items: {
|
|
5956
|
+
type: 'array',
|
|
5957
|
+
items: {
|
|
5958
|
+
$ref: '#/components/schemas/ExternalAccountLinkResponseDto'
|
|
5959
|
+
}
|
|
5960
|
+
},
|
|
5961
|
+
total: {
|
|
5962
|
+
type: 'number'
|
|
5963
|
+
},
|
|
5964
|
+
provider: {
|
|
5965
|
+
type: 'string',
|
|
5966
|
+
description: 'Filter by provider (query param)'
|
|
5967
|
+
}
|
|
5968
|
+
},
|
|
5969
|
+
required: ['items', 'total']
|
|
5970
|
+
} as const;
|
|
5971
|
+
|
|
4937
5972
|
export const $ParserTelemetryReportDto = {
|
|
4938
5973
|
type: 'object',
|
|
4939
5974
|
properties: {}
|
|
@@ -4968,6 +6003,18 @@ export const $ProcessNlpDto = {
|
|
|
4968
6003
|
currency: 'CNY',
|
|
4969
6004
|
payee: 'Starbucks'
|
|
4970
6005
|
}
|
|
6006
|
+
},
|
|
6007
|
+
selectedRuleId: {
|
|
6008
|
+
type: 'string',
|
|
6009
|
+
description:
|
|
6010
|
+
'confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.',
|
|
6011
|
+
example: 'rule_abc123'
|
|
6012
|
+
},
|
|
6013
|
+
selectedAccount: {
|
|
6014
|
+
type: 'string',
|
|
6015
|
+
description:
|
|
6016
|
+
'confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i], or a typed path). Applied directly when the session is confirming_account — no NL re-parse.',
|
|
6017
|
+
example: 'Expenses:Food:Coffee'
|
|
4971
6018
|
}
|
|
4972
6019
|
},
|
|
4973
6020
|
required: ['message']
|
|
@@ -5292,7 +6339,8 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5292
6339
|
},
|
|
5293
6340
|
suggestedAccount: {
|
|
5294
6341
|
type: 'string',
|
|
5295
|
-
description:
|
|
6342
|
+
description:
|
|
6343
|
+
'Suggested replacement account (omitted when no clear candidate)',
|
|
5296
6344
|
example: 'Expenses:Food:Drinks'
|
|
5297
6345
|
},
|
|
5298
6346
|
similarAccounts: {
|
|
@@ -5314,7 +6362,6 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5314
6362
|
},
|
|
5315
6363
|
required: [
|
|
5316
6364
|
'invalidAccount',
|
|
5317
|
-
'suggestedAccount',
|
|
5318
6365
|
'similarAccounts',
|
|
5319
6366
|
'errorMessage',
|
|
5320
6367
|
'transactionContext'
|
|
@@ -5483,11 +6530,12 @@ export const $NlpSuggestedAccountDto = {
|
|
|
5483
6530
|
account: {
|
|
5484
6531
|
type: 'string',
|
|
5485
6532
|
description: 'Suggested account path',
|
|
5486
|
-
example: 'Assets:
|
|
6533
|
+
example: 'Assets:Checking'
|
|
5487
6534
|
},
|
|
5488
6535
|
confidence: {
|
|
5489
6536
|
type: 'number',
|
|
5490
|
-
description:
|
|
6537
|
+
description:
|
|
6538
|
+
'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
|
|
5491
6539
|
example: 0.9
|
|
5492
6540
|
}
|
|
5493
6541
|
},
|
|
@@ -5523,23 +6571,31 @@ export const $NlpDefaultAccountsDto = {
|
|
|
5523
6571
|
properties: {
|
|
5524
6572
|
asset: {
|
|
5525
6573
|
type: 'string',
|
|
5526
|
-
description:
|
|
5527
|
-
|
|
6574
|
+
description:
|
|
6575
|
+
'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
|
|
6576
|
+
example: 'Assets:Checking',
|
|
6577
|
+
nullable: true
|
|
5528
6578
|
},
|
|
5529
6579
|
expense: {
|
|
5530
6580
|
type: 'string',
|
|
5531
|
-
description:
|
|
5532
|
-
|
|
6581
|
+
description:
|
|
6582
|
+
'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
|
|
6583
|
+
example: 'Expenses:Food:Coffee',
|
|
6584
|
+
nullable: true
|
|
5533
6585
|
},
|
|
5534
6586
|
income: {
|
|
5535
6587
|
type: 'string',
|
|
5536
|
-
description:
|
|
5537
|
-
|
|
6588
|
+
description:
|
|
6589
|
+
'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
|
|
6590
|
+
example: 'Income:Salary',
|
|
6591
|
+
nullable: true
|
|
5538
6592
|
},
|
|
5539
6593
|
liability: {
|
|
5540
6594
|
type: 'string',
|
|
5541
|
-
description:
|
|
5542
|
-
|
|
6595
|
+
description:
|
|
6596
|
+
'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
|
|
6597
|
+
example: 'Liabilities:CreditCard',
|
|
6598
|
+
nullable: true
|
|
5543
6599
|
}
|
|
5544
6600
|
},
|
|
5545
6601
|
required: ['asset', 'expense', 'income', 'liability']
|
|
@@ -5564,7 +6620,8 @@ export const $NlpResponseDto = {
|
|
|
5564
6620
|
'confirm_rule',
|
|
5565
6621
|
'confirm_account',
|
|
5566
6622
|
'confirm_payee',
|
|
5567
|
-
'cancel'
|
|
6623
|
+
'cancel',
|
|
6624
|
+
'aborted'
|
|
5568
6625
|
]
|
|
5569
6626
|
},
|
|
5570
6627
|
intent: {
|
|
@@ -5726,7 +6783,7 @@ export const $NlpResponseDto = {
|
|
|
5726
6783
|
},
|
|
5727
6784
|
suggestedAccounts: {
|
|
5728
6785
|
description:
|
|
5729
|
-
'Suggested accounts for this transaction.
|
|
6786
|
+
'Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.',
|
|
5730
6787
|
allOf: [
|
|
5731
6788
|
{
|
|
5732
6789
|
$ref: '#/components/schemas/NlpSuggestedAccountsDto'
|
|
@@ -5735,7 +6792,7 @@ export const $NlpResponseDto = {
|
|
|
5735
6792
|
},
|
|
5736
6793
|
defaultAccounts: {
|
|
5737
6794
|
description:
|
|
5738
|
-
'Default accounts for the user/region.
|
|
6795
|
+
'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
|
|
5739
6796
|
allOf: [
|
|
5740
6797
|
{
|
|
5741
6798
|
$ref: '#/components/schemas/NlpDefaultAccountsDto'
|
|
@@ -5743,24 +6800,255 @@ export const $NlpResponseDto = {
|
|
|
5743
6800
|
]
|
|
5744
6801
|
}
|
|
5745
6802
|
},
|
|
5746
|
-
required: ['status', 'action']
|
|
6803
|
+
required: ['status', 'action']
|
|
6804
|
+
} as const;
|
|
6805
|
+
|
|
6806
|
+
export const $PlatformListItemDto = {
|
|
6807
|
+
type: 'object',
|
|
6808
|
+
properties: {
|
|
6809
|
+
id: {
|
|
6810
|
+
type: 'string',
|
|
6811
|
+
description: 'Global platform ID'
|
|
6812
|
+
},
|
|
6813
|
+
name: {
|
|
6814
|
+
type: 'string',
|
|
6815
|
+
description: 'Platform name'
|
|
6816
|
+
},
|
|
6817
|
+
url: {
|
|
6818
|
+
type: 'string',
|
|
6819
|
+
description: 'Platform URL'
|
|
6820
|
+
},
|
|
6821
|
+
type: {
|
|
6822
|
+
type: 'string',
|
|
6823
|
+
description: 'Platform type',
|
|
6824
|
+
enum: [
|
|
6825
|
+
'BANK',
|
|
6826
|
+
'BROKERAGE',
|
|
6827
|
+
'CRYPTO_EXCHANGE',
|
|
6828
|
+
'PAYMENT',
|
|
6829
|
+
'INVESTMENT',
|
|
6830
|
+
'INSURANCE',
|
|
6831
|
+
'OTHER'
|
|
6832
|
+
]
|
|
6833
|
+
},
|
|
6834
|
+
canonical: {
|
|
6835
|
+
type: 'string',
|
|
6836
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
6837
|
+
},
|
|
6838
|
+
suggestedSegment: {
|
|
6839
|
+
type: 'string',
|
|
6840
|
+
description:
|
|
6841
|
+
'Suggested path segment — canonical with first char uppercased (ACC_COMP_NAME_RE)'
|
|
6842
|
+
},
|
|
6843
|
+
logoUrl: {
|
|
6844
|
+
type: 'string',
|
|
6845
|
+
description: 'Logo URL',
|
|
6846
|
+
nullable: true
|
|
6847
|
+
},
|
|
6848
|
+
isBound: {
|
|
6849
|
+
type: 'boolean',
|
|
6850
|
+
description: 'Whether user has accounts using this platform'
|
|
6851
|
+
}
|
|
6852
|
+
},
|
|
6853
|
+
required: [
|
|
6854
|
+
'id',
|
|
6855
|
+
'name',
|
|
6856
|
+
'url',
|
|
6857
|
+
'type',
|
|
6858
|
+
'canonical',
|
|
6859
|
+
'suggestedSegment',
|
|
6860
|
+
'logoUrl',
|
|
6861
|
+
'isBound'
|
|
6862
|
+
]
|
|
6863
|
+
} as const;
|
|
6864
|
+
|
|
6865
|
+
export const $PlatformMatchResultDto = {
|
|
6866
|
+
type: 'object',
|
|
6867
|
+
properties: {
|
|
6868
|
+
id: {
|
|
6869
|
+
type: 'string',
|
|
6870
|
+
description: 'Global platform ID'
|
|
6871
|
+
},
|
|
6872
|
+
name: {
|
|
6873
|
+
type: 'string',
|
|
6874
|
+
description: 'Platform name (e.g., "ICBC")'
|
|
6875
|
+
},
|
|
6876
|
+
canonical: {
|
|
6877
|
+
type: 'string',
|
|
6878
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
6879
|
+
},
|
|
6880
|
+
type: {
|
|
6881
|
+
type: 'string',
|
|
6882
|
+
description: 'Platform type',
|
|
6883
|
+
enum: [
|
|
6884
|
+
'BANK',
|
|
6885
|
+
'BROKERAGE',
|
|
6886
|
+
'CRYPTO_EXCHANGE',
|
|
6887
|
+
'PAYMENT',
|
|
6888
|
+
'INVESTMENT',
|
|
6889
|
+
'INSURANCE',
|
|
6890
|
+
'OTHER'
|
|
6891
|
+
]
|
|
6892
|
+
},
|
|
6893
|
+
suggestedSegment: {
|
|
6894
|
+
type: 'string',
|
|
6895
|
+
description:
|
|
6896
|
+
'Suggested path segment — canonical, already in ACCOUNT_RE format'
|
|
6897
|
+
},
|
|
6898
|
+
logoUrl: {
|
|
6899
|
+
type: 'string',
|
|
6900
|
+
description: 'Logo URL',
|
|
6901
|
+
nullable: true
|
|
6902
|
+
},
|
|
6903
|
+
matchType: {
|
|
6904
|
+
type: 'string',
|
|
6905
|
+
description: "How this row matched: 'exact' > 'prefix' > 'substring'",
|
|
6906
|
+
enum: ['exact', 'prefix', 'substring']
|
|
6907
|
+
}
|
|
6908
|
+
},
|
|
6909
|
+
required: [
|
|
6910
|
+
'id',
|
|
6911
|
+
'name',
|
|
6912
|
+
'canonical',
|
|
6913
|
+
'type',
|
|
6914
|
+
'suggestedSegment',
|
|
6915
|
+
'logoUrl',
|
|
6916
|
+
'matchType'
|
|
6917
|
+
]
|
|
6918
|
+
} as const;
|
|
6919
|
+
|
|
6920
|
+
export const $PlatformMatchResponseDto = {
|
|
6921
|
+
type: 'object',
|
|
6922
|
+
properties: {
|
|
6923
|
+
platforms: {
|
|
6924
|
+
description: 'Ranked matches, best tier first (at most 10 rows)',
|
|
6925
|
+
type: 'array',
|
|
6926
|
+
items: {
|
|
6927
|
+
$ref: '#/components/schemas/PlatformMatchResultDto'
|
|
6928
|
+
}
|
|
6929
|
+
},
|
|
6930
|
+
matchType: {
|
|
6931
|
+
type: 'string',
|
|
6932
|
+
description:
|
|
6933
|
+
"Overall match quality — top row's tier, or 'none' when no hits",
|
|
6934
|
+
enum: ['none', 'exact', 'prefix', 'substring']
|
|
6935
|
+
},
|
|
6936
|
+
total: {
|
|
6937
|
+
type: 'number',
|
|
6938
|
+
description: 'Total matches before LIMIT (truncation transparency)'
|
|
6939
|
+
},
|
|
6940
|
+
hasMore: {
|
|
6941
|
+
type: 'boolean',
|
|
6942
|
+
description: 'true when total > platforms.length (more matches exist)'
|
|
6943
|
+
}
|
|
6944
|
+
},
|
|
6945
|
+
required: ['platforms', 'matchType', 'total', 'hasMore']
|
|
6946
|
+
} as const;
|
|
6947
|
+
|
|
6948
|
+
export const $CreatePlatformDto = {
|
|
6949
|
+
type: 'object',
|
|
6950
|
+
properties: {
|
|
6951
|
+
name: {
|
|
6952
|
+
type: 'string',
|
|
6953
|
+
description: 'Platform name',
|
|
6954
|
+
example: 'Binance'
|
|
6955
|
+
},
|
|
6956
|
+
canonical: {
|
|
6957
|
+
type: 'string',
|
|
6958
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
6959
|
+
example: 'binance'
|
|
6960
|
+
},
|
|
6961
|
+
aliases: {
|
|
6962
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
6963
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
6964
|
+
type: 'array',
|
|
6965
|
+
items: {
|
|
6966
|
+
type: 'string'
|
|
6967
|
+
}
|
|
6968
|
+
},
|
|
6969
|
+
url: {
|
|
6970
|
+
type: 'string',
|
|
6971
|
+
description: 'Platform URL',
|
|
6972
|
+
example: 'https://www.binance.com'
|
|
6973
|
+
},
|
|
6974
|
+
type: {
|
|
6975
|
+
type: 'string',
|
|
6976
|
+
description: 'Platform type',
|
|
6977
|
+
enum: [
|
|
6978
|
+
'BANK',
|
|
6979
|
+
'BROKERAGE',
|
|
6980
|
+
'CRYPTO_EXCHANGE',
|
|
6981
|
+
'PAYMENT',
|
|
6982
|
+
'INVESTMENT',
|
|
6983
|
+
'INSURANCE',
|
|
6984
|
+
'OTHER'
|
|
6985
|
+
],
|
|
6986
|
+
example: 'CRYPTO_EXCHANGE'
|
|
6987
|
+
},
|
|
6988
|
+
logoUrl: {
|
|
6989
|
+
type: 'string',
|
|
6990
|
+
description: 'Platform logo URL',
|
|
6991
|
+
example: 'https://example.com/logos/binance.png'
|
|
6992
|
+
},
|
|
6993
|
+
isActive: {
|
|
6994
|
+
type: 'boolean',
|
|
6995
|
+
description: 'Whether the platform is active',
|
|
6996
|
+
default: true
|
|
6997
|
+
}
|
|
6998
|
+
},
|
|
6999
|
+
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
5747
7000
|
} as const;
|
|
5748
7001
|
|
|
5749
|
-
export const $
|
|
7002
|
+
export const $UpdatePlatformDto = {
|
|
5750
7003
|
type: 'object',
|
|
5751
7004
|
properties: {
|
|
5752
|
-
|
|
7005
|
+
name: {
|
|
5753
7006
|
type: 'string',
|
|
5754
|
-
description: '
|
|
5755
|
-
example: '
|
|
7007
|
+
description: 'Platform name',
|
|
7008
|
+
example: 'Binance'
|
|
5756
7009
|
},
|
|
5757
|
-
|
|
7010
|
+
canonical: {
|
|
5758
7011
|
type: 'string',
|
|
5759
|
-
description: '
|
|
5760
|
-
example: '
|
|
7012
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
7013
|
+
example: 'binance'
|
|
7014
|
+
},
|
|
7015
|
+
aliases: {
|
|
7016
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
7017
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
7018
|
+
type: 'array',
|
|
7019
|
+
items: {
|
|
7020
|
+
type: 'string'
|
|
7021
|
+
}
|
|
7022
|
+
},
|
|
7023
|
+
url: {
|
|
7024
|
+
type: 'string',
|
|
7025
|
+
description: 'Platform URL',
|
|
7026
|
+
example: 'https://www.binance.com'
|
|
7027
|
+
},
|
|
7028
|
+
type: {
|
|
7029
|
+
type: 'string',
|
|
7030
|
+
description: 'Platform type',
|
|
7031
|
+
enum: [
|
|
7032
|
+
'BANK',
|
|
7033
|
+
'BROKERAGE',
|
|
7034
|
+
'CRYPTO_EXCHANGE',
|
|
7035
|
+
'PAYMENT',
|
|
7036
|
+
'INVESTMENT',
|
|
7037
|
+
'INSURANCE',
|
|
7038
|
+
'OTHER'
|
|
7039
|
+
],
|
|
7040
|
+
example: 'CRYPTO_EXCHANGE'
|
|
7041
|
+
},
|
|
7042
|
+
logoUrl: {
|
|
7043
|
+
type: 'string',
|
|
7044
|
+
description: 'Platform logo URL',
|
|
7045
|
+
example: 'https://example.com/logos/binance.png'
|
|
7046
|
+
},
|
|
7047
|
+
isActive: {
|
|
7048
|
+
type: 'boolean',
|
|
7049
|
+
description: 'Whether the platform is active'
|
|
5761
7050
|
}
|
|
5762
|
-
}
|
|
5763
|
-
required: ['currency', 'balance']
|
|
7051
|
+
}
|
|
5764
7052
|
} as const;
|
|
5765
7053
|
|
|
5766
7054
|
export const $NetWorthByCurrencyDto = {
|
|
@@ -5832,28 +7120,6 @@ export const $ConvertedNetWorthDto = {
|
|
|
5832
7120
|
]
|
|
5833
7121
|
} as const;
|
|
5834
7122
|
|
|
5835
|
-
export const $ExchangeRateWarningDto = {
|
|
5836
|
-
type: 'object',
|
|
5837
|
-
properties: {
|
|
5838
|
-
type: {
|
|
5839
|
-
type: 'string',
|
|
5840
|
-
description: 'Warning type',
|
|
5841
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
5842
|
-
},
|
|
5843
|
-
currency: {
|
|
5844
|
-
type: 'string',
|
|
5845
|
-
description: 'Currency without exchange rate',
|
|
5846
|
-
example: 'EUR'
|
|
5847
|
-
},
|
|
5848
|
-
totalAmount: {
|
|
5849
|
-
type: 'string',
|
|
5850
|
-
description: 'Total amount affected',
|
|
5851
|
-
example: '1000.00'
|
|
5852
|
-
}
|
|
5853
|
-
},
|
|
5854
|
-
required: ['type', 'currency', 'totalAmount']
|
|
5855
|
-
} as const;
|
|
5856
|
-
|
|
5857
7123
|
export const $NetWorthResponseDto = {
|
|
5858
7124
|
type: 'object',
|
|
5859
7125
|
properties: {
|
|
@@ -5939,7 +7205,7 @@ export const $AccountItemDto = {
|
|
|
5939
7205
|
name: {
|
|
5940
7206
|
type: 'string',
|
|
5941
7207
|
description: 'Full account name',
|
|
5942
|
-
example: 'Assets:
|
|
7208
|
+
example: 'Assets:CN:CMB:Savings'
|
|
5943
7209
|
},
|
|
5944
7210
|
displayName: {
|
|
5945
7211
|
type: 'string',
|
|
@@ -5955,6 +7221,12 @@ export const $AccountItemDto = {
|
|
|
5955
7221
|
type: 'string',
|
|
5956
7222
|
description: 'Currency code',
|
|
5957
7223
|
example: 'CNY'
|
|
7224
|
+
},
|
|
7225
|
+
convertedBalance: {
|
|
7226
|
+
type: 'string',
|
|
7227
|
+
description:
|
|
7228
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7229
|
+
example: '50000.00'
|
|
5958
7230
|
}
|
|
5959
7231
|
},
|
|
5960
7232
|
required: ['id', 'name', 'displayName', 'balance', 'currency']
|
|
@@ -5981,11 +7253,66 @@ export const $PlatformGroupDto = {
|
|
|
5981
7253
|
},
|
|
5982
7254
|
totalBalance: {
|
|
5983
7255
|
type: 'string',
|
|
5984
|
-
description: '
|
|
7256
|
+
description: 'FX-converted total balance in base currency',
|
|
7257
|
+
example: '100000.00'
|
|
7258
|
+
},
|
|
7259
|
+
balanceByCurrency: {
|
|
7260
|
+
description: 'Raw (unconverted) balances grouped by currency',
|
|
7261
|
+
type: 'array',
|
|
7262
|
+
items: {
|
|
7263
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7264
|
+
}
|
|
7265
|
+
},
|
|
7266
|
+
convertedBalance: {
|
|
7267
|
+
type: 'string',
|
|
7268
|
+
description:
|
|
7269
|
+
'Converted balance in base currency (omitted when no currency is convertible)',
|
|
5985
7270
|
example: '100000.00'
|
|
7271
|
+
},
|
|
7272
|
+
sharePct: {
|
|
7273
|
+
type: 'number',
|
|
7274
|
+
description:
|
|
7275
|
+
'Share of the grand converted total (0-100); 0 when grand total is 0',
|
|
7276
|
+
example: 42.5
|
|
7277
|
+
}
|
|
7278
|
+
},
|
|
7279
|
+
required: [
|
|
7280
|
+
'platformId',
|
|
7281
|
+
'platformName',
|
|
7282
|
+
'accounts',
|
|
7283
|
+
'totalBalance',
|
|
7284
|
+
'balanceByCurrency',
|
|
7285
|
+
'sharePct'
|
|
7286
|
+
]
|
|
7287
|
+
} as const;
|
|
7288
|
+
|
|
7289
|
+
export const $AccountExchangeRateWarningDto = {
|
|
7290
|
+
type: 'object',
|
|
7291
|
+
properties: {
|
|
7292
|
+
type: {
|
|
7293
|
+
type: 'string',
|
|
7294
|
+
description: 'Warning type',
|
|
7295
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
7296
|
+
},
|
|
7297
|
+
currency: {
|
|
7298
|
+
type: 'string',
|
|
7299
|
+
description: 'Currency without exchange rate',
|
|
7300
|
+
example: 'USD'
|
|
7301
|
+
},
|
|
7302
|
+
accounts: {
|
|
7303
|
+
description: 'Affected account paths',
|
|
7304
|
+
type: 'array',
|
|
7305
|
+
items: {
|
|
7306
|
+
type: 'string'
|
|
7307
|
+
}
|
|
7308
|
+
},
|
|
7309
|
+
totalAmount: {
|
|
7310
|
+
type: 'string',
|
|
7311
|
+
description: 'Total amount in this currency',
|
|
7312
|
+
example: '5000.00'
|
|
5986
7313
|
}
|
|
5987
7314
|
},
|
|
5988
|
-
required: ['
|
|
7315
|
+
required: ['type', 'currency', 'accounts', 'totalAmount']
|
|
5989
7316
|
} as const;
|
|
5990
7317
|
|
|
5991
7318
|
export const $AccountsSummaryDto = {
|
|
@@ -5998,9 +7325,21 @@ export const $AccountsSummaryDto = {
|
|
|
5998
7325
|
totalPlatforms: {
|
|
5999
7326
|
type: 'number',
|
|
6000
7327
|
description: 'Total number of platforms'
|
|
7328
|
+
},
|
|
7329
|
+
baseCurrency: {
|
|
7330
|
+
type: 'string',
|
|
7331
|
+
description: 'Base currency for conversion',
|
|
7332
|
+
example: 'CNY'
|
|
7333
|
+
},
|
|
7334
|
+
warnings: {
|
|
7335
|
+
description: 'Per-account exchange rate warnings',
|
|
7336
|
+
type: 'array',
|
|
7337
|
+
items: {
|
|
7338
|
+
$ref: '#/components/schemas/AccountExchangeRateWarningDto'
|
|
7339
|
+
}
|
|
6001
7340
|
}
|
|
6002
7341
|
},
|
|
6003
|
-
required: ['totalAccounts', 'totalPlatforms']
|
|
7342
|
+
required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
|
|
6004
7343
|
} as const;
|
|
6005
7344
|
|
|
6006
7345
|
export const $AccountsResponseDto = {
|
|
@@ -6035,7 +7374,7 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
6035
7374
|
name: {
|
|
6036
7375
|
type: 'string',
|
|
6037
7376
|
description: 'Full account name',
|
|
6038
|
-
example: 'Assets:
|
|
7377
|
+
example: 'Assets:CN:CMB:Savings'
|
|
6039
7378
|
},
|
|
6040
7379
|
displayName: {
|
|
6041
7380
|
type: 'string',
|
|
@@ -6052,6 +7391,12 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
6052
7391
|
description: 'Currency code',
|
|
6053
7392
|
example: 'CNY'
|
|
6054
7393
|
},
|
|
7394
|
+
convertedBalance: {
|
|
7395
|
+
type: 'string',
|
|
7396
|
+
description:
|
|
7397
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7398
|
+
example: '50000.00'
|
|
7399
|
+
},
|
|
6055
7400
|
assetClass: {
|
|
6056
7401
|
type: 'string',
|
|
6057
7402
|
description: 'Asset class',
|
|
@@ -6131,35 +7476,6 @@ export const $AssetClassGroupDto = {
|
|
|
6131
7476
|
required: ['assetClass', 'accounts', 'balanceByCurrency']
|
|
6132
7477
|
} as const;
|
|
6133
7478
|
|
|
6134
|
-
export const $AccountExchangeRateWarningDto = {
|
|
6135
|
-
type: 'object',
|
|
6136
|
-
properties: {
|
|
6137
|
-
type: {
|
|
6138
|
-
type: 'string',
|
|
6139
|
-
description: 'Warning type',
|
|
6140
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
6141
|
-
},
|
|
6142
|
-
currency: {
|
|
6143
|
-
type: 'string',
|
|
6144
|
-
description: 'Currency without exchange rate',
|
|
6145
|
-
example: 'USD'
|
|
6146
|
-
},
|
|
6147
|
-
accounts: {
|
|
6148
|
-
description: 'Affected account paths',
|
|
6149
|
-
type: 'array',
|
|
6150
|
-
items: {
|
|
6151
|
-
type: 'string'
|
|
6152
|
-
}
|
|
6153
|
-
},
|
|
6154
|
-
totalAmount: {
|
|
6155
|
-
type: 'string',
|
|
6156
|
-
description: 'Total amount in this currency',
|
|
6157
|
-
example: '5000.00'
|
|
6158
|
-
}
|
|
6159
|
-
},
|
|
6160
|
-
required: ['type', 'currency', 'accounts', 'totalAmount']
|
|
6161
|
-
} as const;
|
|
6162
|
-
|
|
6163
7479
|
export const $AssetClassSummaryDto = {
|
|
6164
7480
|
type: 'object',
|
|
6165
7481
|
properties: {
|
|
@@ -6233,7 +7549,7 @@ export const $HoldingAssetClassAccountSliceDto = {
|
|
|
6233
7549
|
accountPath: {
|
|
6234
7550
|
type: 'string',
|
|
6235
7551
|
description: 'Full account path',
|
|
6236
|
-
example: 'Assets:US:
|
|
7552
|
+
example: 'Assets:US:Fidelity:Brokerage'
|
|
6237
7553
|
},
|
|
6238
7554
|
accountCurrency: {
|
|
6239
7555
|
type: 'string',
|
|
@@ -6405,38 +7721,133 @@ export const $CashFlowResponseDto = {
|
|
|
6405
7721
|
description: 'Base currency code',
|
|
6406
7722
|
example: 'CNY'
|
|
6407
7723
|
},
|
|
6408
|
-
byCurrency: {
|
|
6409
|
-
description: 'Cash flow grouped by original currency',
|
|
6410
|
-
allOf: [
|
|
6411
|
-
{
|
|
6412
|
-
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
6413
|
-
}
|
|
6414
|
-
]
|
|
7724
|
+
byCurrency: {
|
|
7725
|
+
description: 'Cash flow grouped by original currency',
|
|
7726
|
+
allOf: [
|
|
7727
|
+
{
|
|
7728
|
+
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
7729
|
+
}
|
|
7730
|
+
]
|
|
7731
|
+
},
|
|
7732
|
+
converted: {
|
|
7733
|
+
description: 'Converted values in base currency',
|
|
7734
|
+
allOf: [
|
|
7735
|
+
{
|
|
7736
|
+
$ref: '#/components/schemas/ConvertedCashFlowDto'
|
|
7737
|
+
}
|
|
7738
|
+
]
|
|
7739
|
+
},
|
|
7740
|
+
warnings: {
|
|
7741
|
+
description: 'Exchange rate warnings',
|
|
7742
|
+
type: 'array',
|
|
7743
|
+
items: {
|
|
7744
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
7745
|
+
}
|
|
7746
|
+
}
|
|
7747
|
+
},
|
|
7748
|
+
required: [
|
|
7749
|
+
'period',
|
|
7750
|
+
'income',
|
|
7751
|
+
'expense',
|
|
7752
|
+
'netSavings',
|
|
7753
|
+
'savingsRate',
|
|
7754
|
+
'currency'
|
|
7755
|
+
]
|
|
7756
|
+
} as const;
|
|
7757
|
+
|
|
7758
|
+
export const $CategoryGroupDto = {
|
|
7759
|
+
type: 'object',
|
|
7760
|
+
properties: {
|
|
7761
|
+
category: {
|
|
7762
|
+
type: 'string',
|
|
7763
|
+
description:
|
|
7764
|
+
'Functional category (account-path Group segment); regional and universal account paths merge under it',
|
|
7765
|
+
example: 'Food'
|
|
7766
|
+
},
|
|
7767
|
+
totalExpense: {
|
|
7768
|
+
type: 'string',
|
|
7769
|
+
description:
|
|
7770
|
+
'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
|
|
7771
|
+
example: '1200.00'
|
|
7772
|
+
},
|
|
7773
|
+
sharePct: {
|
|
7774
|
+
type: 'number',
|
|
7775
|
+
description: 'Share of grand total (0-100); 0 when grand total is 0',
|
|
7776
|
+
example: 42.5
|
|
7777
|
+
},
|
|
7778
|
+
balanceByCurrency: {
|
|
7779
|
+
description: 'Raw (unconverted) expense per currency',
|
|
7780
|
+
type: 'array',
|
|
7781
|
+
items: {
|
|
7782
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7783
|
+
}
|
|
7784
|
+
},
|
|
7785
|
+
convertedBalance: {
|
|
7786
|
+
type: 'string',
|
|
7787
|
+
description:
|
|
7788
|
+
'Converted total in base currency (omitted when FX missing for all currencies in this category)',
|
|
7789
|
+
example: '1200.00'
|
|
7790
|
+
}
|
|
7791
|
+
},
|
|
7792
|
+
required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
|
|
7793
|
+
} as const;
|
|
7794
|
+
|
|
7795
|
+
export const $ExpensesByCategorySummaryDto = {
|
|
7796
|
+
type: 'object',
|
|
7797
|
+
properties: {
|
|
7798
|
+
totalExpense: {
|
|
7799
|
+
type: 'string',
|
|
7800
|
+
description:
|
|
7801
|
+
'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
|
|
7802
|
+
example: '5000.00'
|
|
7803
|
+
},
|
|
7804
|
+
categoryCount: {
|
|
7805
|
+
type: 'number',
|
|
7806
|
+
description: 'Number of categories',
|
|
7807
|
+
example: 8
|
|
7808
|
+
}
|
|
7809
|
+
},
|
|
7810
|
+
required: ['totalExpense', 'categoryCount']
|
|
7811
|
+
} as const;
|
|
7812
|
+
|
|
7813
|
+
export const $ExpensesByCategoryResponseDto = {
|
|
7814
|
+
type: 'object',
|
|
7815
|
+
properties: {
|
|
7816
|
+
period: {
|
|
7817
|
+
type: 'string',
|
|
7818
|
+
description: 'Period requested',
|
|
7819
|
+
example: '1m'
|
|
7820
|
+
},
|
|
7821
|
+
baseCurrency: {
|
|
7822
|
+
type: 'string',
|
|
7823
|
+
description: 'Base currency for converted values',
|
|
7824
|
+
example: 'CNY'
|
|
7825
|
+
},
|
|
7826
|
+
groups: {
|
|
7827
|
+
description:
|
|
7828
|
+
'Expense groups by functional category, sorted by converted total desc',
|
|
7829
|
+
type: 'array',
|
|
7830
|
+
items: {
|
|
7831
|
+
$ref: '#/components/schemas/CategoryGroupDto'
|
|
7832
|
+
}
|
|
6415
7833
|
},
|
|
6416
|
-
|
|
6417
|
-
description: '
|
|
7834
|
+
summary: {
|
|
7835
|
+
description: 'Summary statistics',
|
|
6418
7836
|
allOf: [
|
|
6419
7837
|
{
|
|
6420
|
-
$ref: '#/components/schemas/
|
|
7838
|
+
$ref: '#/components/schemas/ExpensesByCategorySummaryDto'
|
|
6421
7839
|
}
|
|
6422
7840
|
]
|
|
6423
7841
|
},
|
|
6424
7842
|
warnings: {
|
|
6425
|
-
description: 'Exchange rate warnings',
|
|
7843
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
6426
7844
|
type: 'array',
|
|
6427
7845
|
items: {
|
|
6428
7846
|
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
6429
7847
|
}
|
|
6430
7848
|
}
|
|
6431
7849
|
},
|
|
6432
|
-
required: [
|
|
6433
|
-
'period',
|
|
6434
|
-
'income',
|
|
6435
|
-
'expense',
|
|
6436
|
-
'netSavings',
|
|
6437
|
-
'savingsRate',
|
|
6438
|
-
'currency'
|
|
6439
|
-
]
|
|
7850
|
+
required: ['period', 'baseCurrency', 'groups', 'summary']
|
|
6440
7851
|
} as const;
|
|
6441
7852
|
|
|
6442
7853
|
export const $MonetaryDto = {
|
|
@@ -6653,409 +8064,243 @@ export const $HoldingPnlRowDto = {
|
|
|
6653
8064
|
},
|
|
6654
8065
|
required: [
|
|
6655
8066
|
'accountId',
|
|
6656
|
-
'accountPath',
|
|
6657
|
-
'symbol',
|
|
6658
|
-
'chartToken',
|
|
6659
|
-
'assetClass',
|
|
6660
|
-
'units'
|
|
6661
|
-
]
|
|
6662
|
-
} as const;
|
|
6663
|
-
|
|
6664
|
-
export const $HoldingPnlWarningDto = {
|
|
6665
|
-
type: 'object',
|
|
6666
|
-
properties: {
|
|
6667
|
-
type: {
|
|
6668
|
-
type: 'string',
|
|
6669
|
-
description: 'Warning type',
|
|
6670
|
-
example: 'MISSING_COST_FX_RATE',
|
|
6671
|
-
enum: [
|
|
6672
|
-
'MISSING_COST_FX_RATE',
|
|
6673
|
-
'MISSING_MARKET_FX_RATE',
|
|
6674
|
-
'MISSING_SALE_PRICE',
|
|
6675
|
-
'MISSING_REALIZED_FX_RATE',
|
|
6676
|
-
'OVERSOLD_LOTS',
|
|
6677
|
-
'NO_PRICE',
|
|
6678
|
-
'MIXED_COST_CURRENCY'
|
|
6679
|
-
]
|
|
6680
|
-
},
|
|
6681
|
-
symbol: {
|
|
6682
|
-
type: 'object',
|
|
6683
|
-
nullable: true
|
|
6684
|
-
},
|
|
6685
|
-
accountId: {
|
|
6686
|
-
type: 'object',
|
|
6687
|
-
nullable: true
|
|
6688
|
-
},
|
|
6689
|
-
currency: {
|
|
6690
|
-
type: 'object',
|
|
6691
|
-
nullable: true
|
|
6692
|
-
}
|
|
6693
|
-
},
|
|
6694
|
-
required: ['type']
|
|
6695
|
-
} as const;
|
|
6696
|
-
|
|
6697
|
-
export const $HoldingPnlResponseDto = {
|
|
6698
|
-
type: 'object',
|
|
6699
|
-
properties: {
|
|
6700
|
-
asOfDate: {
|
|
6701
|
-
type: 'string',
|
|
6702
|
-
example: '2026-07-08'
|
|
6703
|
-
},
|
|
6704
|
-
baseCurrency: {
|
|
6705
|
-
type: 'string',
|
|
6706
|
-
example: 'CNY'
|
|
6707
|
-
},
|
|
6708
|
-
method: {
|
|
6709
|
-
type: 'string',
|
|
6710
|
-
description:
|
|
6711
|
-
'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
|
|
6712
|
-
enum: ['average', 'FIFO'],
|
|
6713
|
-
example: 'average'
|
|
6714
|
-
},
|
|
6715
|
-
rows: {
|
|
6716
|
-
type: 'array',
|
|
6717
|
-
items: {
|
|
6718
|
-
$ref: '#/components/schemas/HoldingPnlRowDto'
|
|
6719
|
-
}
|
|
6720
|
-
},
|
|
6721
|
-
warnings: {
|
|
6722
|
-
type: 'array',
|
|
6723
|
-
items: {
|
|
6724
|
-
$ref: '#/components/schemas/HoldingPnlWarningDto'
|
|
6725
|
-
}
|
|
6726
|
-
}
|
|
6727
|
-
},
|
|
6728
|
-
required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
|
|
6729
|
-
} as const;
|
|
6730
|
-
|
|
6731
|
-
export const $CreateBeanPriceDto = {
|
|
6732
|
-
type: 'object',
|
|
6733
|
-
properties: {
|
|
6734
|
-
currency: {
|
|
6735
|
-
type: 'string',
|
|
6736
|
-
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
6737
|
-
example: 'USD'
|
|
6738
|
-
},
|
|
6739
|
-
quoteCurrency: {
|
|
6740
|
-
type: 'string',
|
|
6741
|
-
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
6742
|
-
example: 'CNY'
|
|
6743
|
-
},
|
|
6744
|
-
amount: {
|
|
6745
|
-
type: 'number',
|
|
6746
|
-
description:
|
|
6747
|
-
'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
|
|
6748
|
-
example: 175.5,
|
|
6749
|
-
minimum: 0
|
|
6750
|
-
},
|
|
6751
|
-
date: {
|
|
6752
|
-
type: 'string',
|
|
6753
|
-
description: 'Price date (ISO 8601 format)',
|
|
6754
|
-
example: '2024-11-05'
|
|
6755
|
-
},
|
|
6756
|
-
metadata: {
|
|
6757
|
-
type: 'object',
|
|
6758
|
-
description:
|
|
6759
|
-
'Metadata (validated by Zod schema, max field lengths enforced)',
|
|
6760
|
-
example: {
|
|
6761
|
-
source: 'MANUAL',
|
|
6762
|
-
note: 'Bank valuation report',
|
|
6763
|
-
confidence: 0.95
|
|
6764
|
-
}
|
|
6765
|
-
}
|
|
6766
|
-
},
|
|
6767
|
-
required: ['currency', 'quoteCurrency', 'amount', 'date']
|
|
6768
|
-
} as const;
|
|
6769
|
-
|
|
6770
|
-
export const $PriceResponseDto = {
|
|
6771
|
-
type: 'object',
|
|
6772
|
-
properties: {
|
|
6773
|
-
id: {
|
|
6774
|
-
type: 'string',
|
|
6775
|
-
description: 'Unique identifier',
|
|
6776
|
-
example: 'uuid-123-456'
|
|
6777
|
-
},
|
|
6778
|
-
userId: {
|
|
6779
|
-
type: 'string',
|
|
6780
|
-
description: 'User ID (owner of the price)',
|
|
6781
|
-
example: 'user-123'
|
|
6782
|
-
},
|
|
6783
|
-
currency: {
|
|
6784
|
-
type: 'string',
|
|
6785
|
-
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
6786
|
-
example: 'BTC'
|
|
6787
|
-
},
|
|
6788
|
-
quoteCurrency: {
|
|
6789
|
-
type: 'string',
|
|
6790
|
-
description: 'Quote currency (pricing currency, e.g., USD, CNY)',
|
|
6791
|
-
example: 'USD'
|
|
6792
|
-
},
|
|
6793
|
-
amount: {
|
|
6794
|
-
type: 'number',
|
|
6795
|
-
description:
|
|
6796
|
-
'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
|
|
6797
|
-
example: 50000
|
|
6798
|
-
},
|
|
6799
|
-
date: {
|
|
6800
|
-
type: 'string',
|
|
6801
|
-
description:
|
|
6802
|
-
'Price date (ISO 8601 format). Represents the date this price was valid.',
|
|
6803
|
-
example: '2024-01-01',
|
|
6804
|
-
format: 'date'
|
|
6805
|
-
},
|
|
6806
|
-
meta: {
|
|
6807
|
-
type: 'object',
|
|
6808
|
-
description:
|
|
6809
|
-
'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
|
|
6810
|
-
example: {
|
|
6811
|
-
source: 'MANUAL',
|
|
6812
|
-
note: 'User-defined price',
|
|
6813
|
-
confidence: 1
|
|
6814
|
-
}
|
|
6815
|
-
},
|
|
6816
|
-
createdAt: {
|
|
6817
|
-
format: 'date-time',
|
|
6818
|
-
type: 'string',
|
|
6819
|
-
description: 'Creation timestamp',
|
|
6820
|
-
example: '2024-11-03T10:00:00Z'
|
|
6821
|
-
},
|
|
6822
|
-
updatedAt: {
|
|
6823
|
-
format: 'date-time',
|
|
6824
|
-
type: 'string',
|
|
6825
|
-
description: 'Last update timestamp',
|
|
6826
|
-
example: '2024-11-03T10:00:00Z'
|
|
6827
|
-
}
|
|
6828
|
-
},
|
|
6829
|
-
required: [
|
|
6830
|
-
'id',
|
|
6831
|
-
'userId',
|
|
6832
|
-
'currency',
|
|
6833
|
-
'quoteCurrency',
|
|
6834
|
-
'amount',
|
|
6835
|
-
'date',
|
|
6836
|
-
'meta',
|
|
6837
|
-
'createdAt',
|
|
6838
|
-
'updatedAt'
|
|
6839
|
-
]
|
|
6840
|
-
} as const;
|
|
6841
|
-
|
|
6842
|
-
export const $PriceListResponseDto = {
|
|
6843
|
-
type: 'object',
|
|
6844
|
-
properties: {
|
|
6845
|
-
items: {
|
|
6846
|
-
description: 'List of prices',
|
|
6847
|
-
type: 'array',
|
|
6848
|
-
items: {
|
|
6849
|
-
$ref: '#/components/schemas/PriceResponseDto'
|
|
6850
|
-
}
|
|
6851
|
-
},
|
|
6852
|
-
total: {
|
|
6853
|
-
type: 'number',
|
|
6854
|
-
description: 'Total number of prices',
|
|
6855
|
-
example: 42
|
|
6856
|
-
}
|
|
6857
|
-
},
|
|
6858
|
-
required: ['items', 'total']
|
|
6859
|
-
} as const;
|
|
6860
|
-
|
|
6861
|
-
export const $UpdateBeanPriceDto = {
|
|
6862
|
-
type: 'object',
|
|
6863
|
-
properties: {
|
|
6864
|
-
currency: {
|
|
6865
|
-
type: 'string',
|
|
6866
|
-
description: 'Currency being priced'
|
|
6867
|
-
},
|
|
6868
|
-
quoteCurrency: {
|
|
6869
|
-
type: 'string',
|
|
6870
|
-
description: 'Quote currency (pricing currency)'
|
|
6871
|
-
},
|
|
6872
|
-
amount: {
|
|
6873
|
-
type: 'number',
|
|
6874
|
-
description: 'Price amount (MUST be >= 0 per Beancount spec)',
|
|
6875
|
-
minimum: 0
|
|
6876
|
-
},
|
|
6877
|
-
date: {
|
|
6878
|
-
type: 'string',
|
|
6879
|
-
description: 'Price date (ISO 8601 format)'
|
|
6880
|
-
},
|
|
6881
|
-
metadata: {
|
|
6882
|
-
type: 'object',
|
|
6883
|
-
description: 'Metadata'
|
|
6884
|
-
}
|
|
6885
|
-
}
|
|
8067
|
+
'accountPath',
|
|
8068
|
+
'symbol',
|
|
8069
|
+
'chartToken',
|
|
8070
|
+
'assetClass',
|
|
8071
|
+
'units'
|
|
8072
|
+
]
|
|
6886
8073
|
} as const;
|
|
6887
8074
|
|
|
6888
|
-
export const $
|
|
8075
|
+
export const $HoldingPnlWarningDto = {
|
|
6889
8076
|
type: 'object',
|
|
6890
8077
|
properties: {
|
|
6891
|
-
|
|
8078
|
+
type: {
|
|
6892
8079
|
type: 'string',
|
|
6893
|
-
description: '
|
|
6894
|
-
example: '
|
|
8080
|
+
description: 'Warning type',
|
|
8081
|
+
example: 'MISSING_COST_FX_RATE',
|
|
8082
|
+
enum: [
|
|
8083
|
+
'MISSING_COST_FX_RATE',
|
|
8084
|
+
'MISSING_MARKET_FX_RATE',
|
|
8085
|
+
'MISSING_SALE_PRICE',
|
|
8086
|
+
'MISSING_REALIZED_FX_RATE',
|
|
8087
|
+
'OVERSOLD_LOTS',
|
|
8088
|
+
'NO_PRICE',
|
|
8089
|
+
'MIXED_COST_CURRENCY'
|
|
8090
|
+
]
|
|
6895
8091
|
},
|
|
6896
|
-
|
|
6897
|
-
type: '
|
|
6898
|
-
|
|
6899
|
-
|
|
8092
|
+
symbol: {
|
|
8093
|
+
type: 'object',
|
|
8094
|
+
nullable: true
|
|
8095
|
+
},
|
|
8096
|
+
accountId: {
|
|
8097
|
+
type: 'object',
|
|
8098
|
+
nullable: true
|
|
8099
|
+
},
|
|
8100
|
+
currency: {
|
|
8101
|
+
type: 'object',
|
|
8102
|
+
nullable: true
|
|
6900
8103
|
}
|
|
6901
8104
|
},
|
|
6902
|
-
required: ['
|
|
8105
|
+
required: ['type']
|
|
6903
8106
|
} as const;
|
|
6904
8107
|
|
|
6905
|
-
export const $
|
|
8108
|
+
export const $HoldingPnlResponseDto = {
|
|
6906
8109
|
type: 'object',
|
|
6907
8110
|
properties: {
|
|
6908
|
-
|
|
8111
|
+
asOfDate: {
|
|
6909
8112
|
type: 'string',
|
|
6910
|
-
|
|
6911
|
-
example: '2024-06-15'
|
|
8113
|
+
example: '2026-07-08'
|
|
6912
8114
|
},
|
|
6913
|
-
|
|
8115
|
+
baseCurrency: {
|
|
6914
8116
|
type: 'string',
|
|
6915
|
-
|
|
6916
|
-
example: '500000.00'
|
|
8117
|
+
example: 'CNY'
|
|
6917
8118
|
},
|
|
6918
|
-
|
|
6919
|
-
type: '
|
|
6920
|
-
description:
|
|
6921
|
-
|
|
8119
|
+
method: {
|
|
8120
|
+
type: 'string',
|
|
8121
|
+
description:
|
|
8122
|
+
'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
|
|
8123
|
+
enum: ['average', 'FIFO'],
|
|
8124
|
+
example: 'average'
|
|
6922
8125
|
},
|
|
6923
|
-
|
|
6924
|
-
description: 'Multi-currency breakdown for this point',
|
|
8126
|
+
rows: {
|
|
6925
8127
|
type: 'array',
|
|
6926
8128
|
items: {
|
|
6927
|
-
$ref: '#/components/schemas/
|
|
8129
|
+
$ref: '#/components/schemas/HoldingPnlRowDto'
|
|
8130
|
+
}
|
|
8131
|
+
},
|
|
8132
|
+
warnings: {
|
|
8133
|
+
type: 'array',
|
|
8134
|
+
items: {
|
|
8135
|
+
$ref: '#/components/schemas/HoldingPnlWarningDto'
|
|
6928
8136
|
}
|
|
6929
8137
|
}
|
|
6930
8138
|
},
|
|
6931
|
-
required: ['
|
|
8139
|
+
required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
|
|
6932
8140
|
} as const;
|
|
6933
8141
|
|
|
6934
|
-
export const $
|
|
8142
|
+
export const $AnonymousLoginDto = {
|
|
6935
8143
|
type: 'object',
|
|
6936
8144
|
properties: {
|
|
6937
|
-
|
|
6938
|
-
type: 'string',
|
|
6939
|
-
description: 'Value at start of period',
|
|
6940
|
-
example: '450000.00'
|
|
6941
|
-
},
|
|
6942
|
-
endValue: {
|
|
6943
|
-
type: 'string',
|
|
6944
|
-
description: 'Value at end of period',
|
|
6945
|
-
example: '500000.00'
|
|
6946
|
-
},
|
|
6947
|
-
totalChange: {
|
|
6948
|
-
type: 'string',
|
|
6949
|
-
description: 'Total change over period',
|
|
6950
|
-
example: '50000.00'
|
|
6951
|
-
},
|
|
6952
|
-
totalChangePercentage: {
|
|
8145
|
+
accessToken: {
|
|
6953
8146
|
type: 'string',
|
|
6954
|
-
description: '
|
|
6955
|
-
example: '+11.11%'
|
|
8147
|
+
description: 'Access token for anonymous login'
|
|
6956
8148
|
}
|
|
6957
8149
|
},
|
|
6958
|
-
required: ['
|
|
8150
|
+
required: ['accessToken']
|
|
6959
8151
|
} as const;
|
|
6960
8152
|
|
|
6961
|
-
export const $
|
|
8153
|
+
export const $AnonymousLoginResponseDto = {
|
|
6962
8154
|
type: 'object',
|
|
6963
8155
|
properties: {
|
|
6964
|
-
|
|
8156
|
+
authToken: {
|
|
6965
8157
|
type: 'string',
|
|
6966
|
-
description: '
|
|
6967
|
-
example: '
|
|
6968
|
-
},
|
|
6969
|
-
byCurrency: {
|
|
6970
|
-
description: 'Balances by currency',
|
|
6971
|
-
type: 'array',
|
|
6972
|
-
items: {
|
|
6973
|
-
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
6974
|
-
}
|
|
8158
|
+
description: 'JWT auth token',
|
|
8159
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
6975
8160
|
}
|
|
6976
8161
|
},
|
|
6977
|
-
required: ['
|
|
8162
|
+
required: ['authToken']
|
|
6978
8163
|
} as const;
|
|
6979
8164
|
|
|
6980
|
-
export const $
|
|
8165
|
+
export const $SymbolSearchResultDto = {
|
|
6981
8166
|
type: 'object',
|
|
6982
8167
|
properties: {
|
|
6983
|
-
|
|
6984
|
-
|
|
6985
|
-
|
|
6986
|
-
items: {
|
|
6987
|
-
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
6988
|
-
}
|
|
8168
|
+
symbol: {
|
|
8169
|
+
type: 'string',
|
|
8170
|
+
example: 'AAPL'
|
|
6989
8171
|
},
|
|
6990
|
-
|
|
6991
|
-
|
|
6992
|
-
|
|
6993
|
-
|
|
6994
|
-
$ref: '#/components/schemas/TrendSummaryDto'
|
|
6995
|
-
}
|
|
6996
|
-
]
|
|
8172
|
+
name: {
|
|
8173
|
+
type: 'object',
|
|
8174
|
+
example: 'Apple Inc.',
|
|
8175
|
+
nullable: true
|
|
6997
8176
|
},
|
|
6998
|
-
|
|
6999
|
-
type: '
|
|
7000
|
-
|
|
7001
|
-
|
|
8177
|
+
exchange: {
|
|
8178
|
+
type: 'object',
|
|
8179
|
+
example: 'US',
|
|
8180
|
+
nullable: true
|
|
7002
8181
|
},
|
|
7003
|
-
|
|
7004
|
-
type: '
|
|
7005
|
-
description: '
|
|
7006
|
-
example: '
|
|
8182
|
+
assetType: {
|
|
8183
|
+
type: 'object',
|
|
8184
|
+
description: 'OpenBB asset_type (e.g. stock, etf)',
|
|
8185
|
+
example: 'stock',
|
|
8186
|
+
nullable: true
|
|
7007
8187
|
},
|
|
7008
|
-
|
|
7009
|
-
type: '
|
|
7010
|
-
description: '
|
|
7011
|
-
example: '
|
|
8188
|
+
assetClass: {
|
|
8189
|
+
type: 'object',
|
|
8190
|
+
description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
|
|
8191
|
+
example: 'EQUITY',
|
|
8192
|
+
nullable: true
|
|
7012
8193
|
},
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
|
|
7016
|
-
|
|
7017
|
-
|
|
7018
|
-
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
7019
|
-
}
|
|
8194
|
+
assetSubClass: {
|
|
8195
|
+
type: 'object',
|
|
8196
|
+
description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
|
|
8197
|
+
example: 'STOCK',
|
|
8198
|
+
nullable: true
|
|
7020
8199
|
},
|
|
7021
|
-
|
|
7022
|
-
|
|
7023
|
-
|
|
7024
|
-
|
|
7025
|
-
|
|
7026
|
-
}
|
|
8200
|
+
currency: {
|
|
8201
|
+
type: 'object',
|
|
8202
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8203
|
+
example: 'USD',
|
|
8204
|
+
nullable: true
|
|
7027
8205
|
}
|
|
7028
8206
|
},
|
|
7029
|
-
required: ['
|
|
7030
|
-
} as const;
|
|
7031
|
-
|
|
7032
|
-
export const $GenerateSnapshotBody = {
|
|
7033
|
-
type: 'object',
|
|
7034
|
-
properties: {}
|
|
7035
|
-
} as const;
|
|
7036
|
-
|
|
7037
|
-
export const $GenerateSnapshotResponse = {
|
|
7038
|
-
type: 'object',
|
|
7039
|
-
properties: {}
|
|
7040
|
-
} as const;
|
|
7041
|
-
|
|
7042
|
-
export const $BackfillSnapshotsBody = {
|
|
7043
|
-
type: 'object',
|
|
7044
|
-
properties: {}
|
|
7045
|
-
} as const;
|
|
7046
|
-
|
|
7047
|
-
export const $BackfillSnapshotsResponse = {
|
|
7048
|
-
type: 'object',
|
|
7049
|
-
properties: {}
|
|
8207
|
+
required: ['symbol']
|
|
7050
8208
|
} as const;
|
|
7051
8209
|
|
|
7052
|
-
export const $
|
|
8210
|
+
export const $SymbolQuoteDto = {
|
|
7053
8211
|
type: 'object',
|
|
7054
8212
|
properties: {
|
|
7055
|
-
|
|
8213
|
+
symbol: {
|
|
7056
8214
|
type: 'string',
|
|
7057
|
-
|
|
8215
|
+
example: 'AAPL'
|
|
8216
|
+
},
|
|
8217
|
+
name: {
|
|
8218
|
+
type: 'object',
|
|
8219
|
+
example: 'Apple Inc.',
|
|
8220
|
+
nullable: true
|
|
8221
|
+
},
|
|
8222
|
+
exchange: {
|
|
8223
|
+
type: 'object',
|
|
8224
|
+
example: 'US',
|
|
8225
|
+
nullable: true
|
|
8226
|
+
},
|
|
8227
|
+
assetType: {
|
|
8228
|
+
type: 'object',
|
|
8229
|
+
description: 'OpenBB asset_type',
|
|
8230
|
+
example: 'stock',
|
|
8231
|
+
nullable: true
|
|
8232
|
+
},
|
|
8233
|
+
assetClass: {
|
|
8234
|
+
type: 'object',
|
|
8235
|
+
description: 'IGN asset class',
|
|
8236
|
+
example: 'EQUITY',
|
|
8237
|
+
nullable: true
|
|
8238
|
+
},
|
|
8239
|
+
assetSubClass: {
|
|
8240
|
+
type: 'object',
|
|
8241
|
+
description: 'IGN asset sub-class',
|
|
8242
|
+
example: 'STOCK',
|
|
8243
|
+
nullable: true
|
|
8244
|
+
},
|
|
8245
|
+
currency: {
|
|
8246
|
+
type: 'object',
|
|
8247
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8248
|
+
example: 'USD',
|
|
8249
|
+
nullable: true
|
|
8250
|
+
},
|
|
8251
|
+
price: {
|
|
8252
|
+
type: 'object',
|
|
8253
|
+
description: 'Latest price (Decimal string)',
|
|
8254
|
+
example: '189.84',
|
|
8255
|
+
nullable: true
|
|
8256
|
+
},
|
|
8257
|
+
priceDate: {
|
|
8258
|
+
type: 'object',
|
|
8259
|
+
description: 'Date the price was observed (ISO yyyy-MM-dd)',
|
|
8260
|
+
example: '2026-08-05',
|
|
8261
|
+
nullable: true
|
|
8262
|
+
},
|
|
8263
|
+
changePercent: {
|
|
8264
|
+
type: 'object',
|
|
8265
|
+
description:
|
|
8266
|
+
'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.',
|
|
8267
|
+
example: 1.7,
|
|
8268
|
+
nullable: true
|
|
8269
|
+
},
|
|
8270
|
+
prevClose: {
|
|
8271
|
+
type: 'object',
|
|
8272
|
+
description: 'Previous close (Decimal string)',
|
|
8273
|
+
nullable: true
|
|
8274
|
+
},
|
|
8275
|
+
open: {
|
|
8276
|
+
type: 'object',
|
|
8277
|
+
description: 'Day open (Decimal string)',
|
|
8278
|
+
nullable: true
|
|
8279
|
+
},
|
|
8280
|
+
high: {
|
|
8281
|
+
type: 'object',
|
|
8282
|
+
description: 'Day high (Decimal string)',
|
|
8283
|
+
nullable: true
|
|
8284
|
+
},
|
|
8285
|
+
low: {
|
|
8286
|
+
type: 'object',
|
|
8287
|
+
description: 'Day low (Decimal string)',
|
|
8288
|
+
nullable: true
|
|
8289
|
+
},
|
|
8290
|
+
volume: {
|
|
8291
|
+
type: 'object',
|
|
8292
|
+
description: 'Day volume (Decimal string)',
|
|
8293
|
+
nullable: true
|
|
8294
|
+
},
|
|
8295
|
+
yearHigh: {
|
|
8296
|
+
type: 'object',
|
|
8297
|
+
description: '52-week high (Decimal string)',
|
|
8298
|
+
nullable: true
|
|
8299
|
+
},
|
|
8300
|
+
yearLow: {
|
|
8301
|
+
type: 'object',
|
|
8302
|
+
description: '52-week low (Decimal string)',
|
|
8303
|
+
nullable: true
|
|
7058
8304
|
}
|
|
7059
|
-
}
|
|
7060
|
-
required: ['accessToken']
|
|
8305
|
+
}
|
|
7061
8306
|
} as const;
|