@firela/api-types 0.0.0-canary.2b8fcbd8 → 0.0.0-canary.2e2a26ba
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 +4054 -2815
- package/dist/index.d.ts +4054 -2815
- package/dist/index.js +31 -3
- package/dist/index.mjs +31 -3
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +1983 -829
- package/src/generated/services.gen.ts +1338 -746
- package/src/generated/types.gen.ts +4514 -3103
|
@@ -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,47 @@ export const $AccountResponseDto = {
|
|
|
104
88
|
enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
|
|
105
89
|
example: 'Assets'
|
|
106
90
|
},
|
|
91
|
+
assetSubClass: {
|
|
92
|
+
type: 'string',
|
|
93
|
+
description:
|
|
94
|
+
'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
|
|
95
|
+
enum: [
|
|
96
|
+
'DEPOSIT',
|
|
97
|
+
'CASH',
|
|
98
|
+
'MONEY_MARKET_FUND',
|
|
99
|
+
'STOCK',
|
|
100
|
+
'ETF',
|
|
101
|
+
'MUTUAL_FUND',
|
|
102
|
+
'EQUITY_COMPENSATION',
|
|
103
|
+
'GOVERNMENT_BOND',
|
|
104
|
+
'CORPORATE_BOND',
|
|
105
|
+
'BOND_FUND',
|
|
106
|
+
'PRIMARY_RESIDENCE',
|
|
107
|
+
'INVESTMENT_PROPERTY',
|
|
108
|
+
'REIT',
|
|
109
|
+
'GOLD',
|
|
110
|
+
'SILVER',
|
|
111
|
+
'PRECIOUS_METAL',
|
|
112
|
+
'PRECIOUS_METAL_FUND',
|
|
113
|
+
'COMMODITY',
|
|
114
|
+
'COMMODITY_FUND',
|
|
115
|
+
'CRYPTOCURRENCY',
|
|
116
|
+
'RETIREMENT_ACCOUNT',
|
|
117
|
+
'HEALTH_ACCOUNT',
|
|
118
|
+
'EDUCATION_ACCOUNT',
|
|
119
|
+
'INSURANCE',
|
|
120
|
+
'PRIVATE_EQUITY',
|
|
121
|
+
'HEDGE_FUND',
|
|
122
|
+
'COLLECTIBLES',
|
|
123
|
+
'MORTGAGE',
|
|
124
|
+
'STUDENT_LOAN',
|
|
125
|
+
'CREDIT_CARD',
|
|
126
|
+
'PERSONAL_LOAN',
|
|
127
|
+
'OTHER'
|
|
128
|
+
],
|
|
129
|
+
nullable: true,
|
|
130
|
+
example: 'STOCK'
|
|
131
|
+
},
|
|
107
132
|
status: {
|
|
108
133
|
type: 'string',
|
|
109
134
|
description: 'Account status',
|
|
@@ -145,26 +170,26 @@ export const $AccountResponseDto = {
|
|
|
145
170
|
templatePath: {
|
|
146
171
|
type: 'string',
|
|
147
172
|
description: 'Template path reference',
|
|
148
|
-
example: 'Assets:CN:
|
|
173
|
+
example: 'Assets:CN:Checking'
|
|
149
174
|
},
|
|
150
175
|
isCustom: {
|
|
151
176
|
type: 'boolean',
|
|
152
177
|
description: 'Whether this is a custom (user-created) account',
|
|
153
178
|
example: false
|
|
154
179
|
},
|
|
155
|
-
|
|
180
|
+
displayName: {
|
|
156
181
|
type: 'string',
|
|
157
|
-
description: '
|
|
158
|
-
example: '
|
|
182
|
+
description: 'Localized display name (ADR-0114, read-time projection)',
|
|
183
|
+
example: 'Checking'
|
|
159
184
|
},
|
|
160
185
|
icon: {
|
|
161
186
|
type: 'string',
|
|
162
187
|
description: 'Icon identifier',
|
|
163
188
|
example: 'bank-icbc'
|
|
164
189
|
},
|
|
165
|
-
|
|
190
|
+
openDirectiveMeta: {
|
|
166
191
|
type: 'object',
|
|
167
|
-
description: '
|
|
192
|
+
description: 'Open directive metadata (ADR-0115 Decision 9)',
|
|
168
193
|
example: {
|
|
169
194
|
branch: 'Downtown'
|
|
170
195
|
}
|
|
@@ -192,7 +217,6 @@ export const $AccountResponseDto = {
|
|
|
192
217
|
required: [
|
|
193
218
|
'id',
|
|
194
219
|
'path',
|
|
195
|
-
'displayName',
|
|
196
220
|
'type',
|
|
197
221
|
'status',
|
|
198
222
|
'openDate',
|
|
@@ -225,11 +249,6 @@ export const $AccountListResponseDto = {
|
|
|
225
249
|
export const $UpdateAccountDto = {
|
|
226
250
|
type: 'object',
|
|
227
251
|
properties: {
|
|
228
|
-
displayName: {
|
|
229
|
-
type: 'string',
|
|
230
|
-
description: 'Display name to distinguish accounts at the same path',
|
|
231
|
-
example: '招行工资卡'
|
|
232
|
-
},
|
|
233
252
|
currencies: {
|
|
234
253
|
description: 'Allowed currencies (null = no restriction)',
|
|
235
254
|
example: ['CNY', 'USD'],
|
|
@@ -251,19 +270,15 @@ export const $UpdateAccountDto = {
|
|
|
251
270
|
'NONE'
|
|
252
271
|
]
|
|
253
272
|
},
|
|
254
|
-
i18nKey: {
|
|
255
|
-
type: 'string',
|
|
256
|
-
description: 'i18n key for display name',
|
|
257
|
-
example: 'account.custom.mybank'
|
|
258
|
-
},
|
|
259
273
|
icon: {
|
|
260
274
|
type: 'string',
|
|
261
275
|
description: 'Icon identifier',
|
|
262
276
|
example: 'bank-custom'
|
|
263
277
|
},
|
|
264
|
-
|
|
278
|
+
openDirectiveMeta: {
|
|
265
279
|
type: 'object',
|
|
266
|
-
description:
|
|
280
|
+
description:
|
|
281
|
+
'Open directive metadata (merged with existing; NOT an opening-balance amount)',
|
|
267
282
|
example: {
|
|
268
283
|
branch: 'Uptown'
|
|
269
284
|
}
|
|
@@ -310,13 +325,47 @@ export const $ReopenAccountDto = {
|
|
|
310
325
|
}
|
|
311
326
|
} as const;
|
|
312
327
|
|
|
328
|
+
export const $CreateOpeningBalanceDto = {
|
|
329
|
+
type: 'object',
|
|
330
|
+
properties: {
|
|
331
|
+
amount: {
|
|
332
|
+
type: 'number',
|
|
333
|
+
description: 'Opening balance amount (non-negative)',
|
|
334
|
+
example: 1000
|
|
335
|
+
},
|
|
336
|
+
currency: {
|
|
337
|
+
type: 'string',
|
|
338
|
+
description: 'Currency code',
|
|
339
|
+
example: 'CNY'
|
|
340
|
+
},
|
|
341
|
+
date: {
|
|
342
|
+
format: 'date-time',
|
|
343
|
+
type: 'string',
|
|
344
|
+
description: 'Opening-balance date (defaults to now)',
|
|
345
|
+
example: '2024-01-01'
|
|
346
|
+
}
|
|
347
|
+
},
|
|
348
|
+
required: ['amount', 'currency']
|
|
349
|
+
} as const;
|
|
350
|
+
|
|
351
|
+
export const $OpeningBalanceResultDto = {
|
|
352
|
+
type: 'object',
|
|
353
|
+
properties: {
|
|
354
|
+
transactionId: {
|
|
355
|
+
type: 'string',
|
|
356
|
+
description: 'Created opening-balance transaction id.'
|
|
357
|
+
}
|
|
358
|
+
},
|
|
359
|
+
required: ['transactionId']
|
|
360
|
+
} as const;
|
|
361
|
+
|
|
313
362
|
export const $AccountStandardResponseDto = {
|
|
314
363
|
type: 'object',
|
|
315
364
|
properties: {
|
|
316
365
|
path: {
|
|
317
366
|
type: 'string',
|
|
318
367
|
description: 'Account path (hierarchical, colon-separated)',
|
|
319
|
-
example: 'Assets:CN:
|
|
368
|
+
example: 'Assets:CN:Checking'
|
|
320
369
|
},
|
|
321
370
|
type: {
|
|
322
371
|
type: 'string',
|
|
@@ -324,11 +373,6 @@ export const $AccountStandardResponseDto = {
|
|
|
324
373
|
enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
|
|
325
374
|
example: 'Assets'
|
|
326
375
|
},
|
|
327
|
-
i18nKey: {
|
|
328
|
-
type: 'string',
|
|
329
|
-
description: 'i18n key for localized display name',
|
|
330
|
-
example: 'account.assets.cn.bank.icbc.checking'
|
|
331
|
-
},
|
|
332
376
|
name: {
|
|
333
377
|
type: 'string',
|
|
334
378
|
description: 'Short localized display name',
|
|
@@ -353,7 +397,7 @@ export const $AccountStandardResponseDto = {
|
|
|
353
397
|
example: 'bank-icbc'
|
|
354
398
|
}
|
|
355
399
|
},
|
|
356
|
-
required: ['path', 'type', '
|
|
400
|
+
required: ['path', 'type', 'description', 'tags', 'icon']
|
|
357
401
|
} as const;
|
|
358
402
|
|
|
359
403
|
export const $AccountStandardListResponseDto = {
|
|
@@ -383,18 +427,13 @@ export const $AccountStandardListResponseDto = {
|
|
|
383
427
|
export const $TemplateMetadataDto = {
|
|
384
428
|
type: 'object',
|
|
385
429
|
properties: {
|
|
386
|
-
extendable: {
|
|
387
|
-
type: 'boolean',
|
|
388
|
-
description: 'Whether this path can be extended',
|
|
389
|
-
example: true
|
|
390
|
-
},
|
|
391
430
|
rootType: {
|
|
392
431
|
type: 'string',
|
|
393
432
|
description: 'Root account type',
|
|
394
433
|
example: 'Assets'
|
|
395
434
|
}
|
|
396
435
|
},
|
|
397
|
-
required: ['
|
|
436
|
+
required: ['rootType']
|
|
398
437
|
} as const;
|
|
399
438
|
|
|
400
439
|
export const $TemplateMetadataResponseDto = {
|
|
@@ -533,7 +572,7 @@ export const $CreatePostingDto = {
|
|
|
533
572
|
type: 'string',
|
|
534
573
|
description:
|
|
535
574
|
'Account name in Beancount format (must start with uppercase, colon-separated)',
|
|
536
|
-
example: 'Assets:
|
|
575
|
+
example: 'Assets:Checking'
|
|
537
576
|
},
|
|
538
577
|
units: {
|
|
539
578
|
type: 'string',
|
|
@@ -692,7 +731,7 @@ export const $PostingResponseDto = {
|
|
|
692
731
|
account: {
|
|
693
732
|
type: 'string',
|
|
694
733
|
description: 'Account name',
|
|
695
|
-
example: 'Assets:
|
|
734
|
+
example: 'Assets:Checking'
|
|
696
735
|
},
|
|
697
736
|
units: {
|
|
698
737
|
type: 'string',
|
|
@@ -1058,7 +1097,7 @@ export const $PostingDetailDto = {
|
|
|
1058
1097
|
account: {
|
|
1059
1098
|
type: 'string',
|
|
1060
1099
|
description: 'Fully-qualified Beancount account path',
|
|
1061
|
-
example: 'Assets:
|
|
1100
|
+
example: 'Assets:Checking'
|
|
1062
1101
|
},
|
|
1063
1102
|
units: {
|
|
1064
1103
|
type: 'string',
|
|
@@ -1247,6 +1286,77 @@ export const $TransactionDetailDto = {
|
|
|
1247
1286
|
]
|
|
1248
1287
|
} as const;
|
|
1249
1288
|
|
|
1289
|
+
export const $BalanceByCurrencyDto = {
|
|
1290
|
+
type: 'object',
|
|
1291
|
+
properties: {
|
|
1292
|
+
currency: {
|
|
1293
|
+
type: 'string',
|
|
1294
|
+
description: 'ISO 4217 currency code',
|
|
1295
|
+
example: 'CNY'
|
|
1296
|
+
},
|
|
1297
|
+
balance: {
|
|
1298
|
+
type: 'string',
|
|
1299
|
+
description: 'Balance amount',
|
|
1300
|
+
example: '50000.00'
|
|
1301
|
+
}
|
|
1302
|
+
},
|
|
1303
|
+
required: ['currency', 'balance']
|
|
1304
|
+
} as const;
|
|
1305
|
+
|
|
1306
|
+
export const $ExchangeRateWarningDto = {
|
|
1307
|
+
type: 'object',
|
|
1308
|
+
properties: {
|
|
1309
|
+
type: {
|
|
1310
|
+
type: 'string',
|
|
1311
|
+
description: 'Warning type',
|
|
1312
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
1313
|
+
},
|
|
1314
|
+
currency: {
|
|
1315
|
+
type: 'string',
|
|
1316
|
+
description: 'Currency without exchange rate',
|
|
1317
|
+
example: 'EUR'
|
|
1318
|
+
},
|
|
1319
|
+
totalAmount: {
|
|
1320
|
+
type: 'string',
|
|
1321
|
+
description: 'Total amount affected',
|
|
1322
|
+
example: '1000.00'
|
|
1323
|
+
}
|
|
1324
|
+
},
|
|
1325
|
+
required: ['type', 'currency', 'totalAmount']
|
|
1326
|
+
} as const;
|
|
1327
|
+
|
|
1328
|
+
export const $TransactionListSummaryDto = {
|
|
1329
|
+
type: 'object',
|
|
1330
|
+
properties: {
|
|
1331
|
+
totalAmount: {
|
|
1332
|
+
type: 'string',
|
|
1333
|
+
description:
|
|
1334
|
+
'Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.',
|
|
1335
|
+
example: '-6000.00'
|
|
1336
|
+
},
|
|
1337
|
+
currency: {
|
|
1338
|
+
type: 'string',
|
|
1339
|
+
description: 'Base currency (ISO 4217)',
|
|
1340
|
+
example: 'CNY'
|
|
1341
|
+
},
|
|
1342
|
+
balanceByCurrency: {
|
|
1343
|
+
description: 'Raw (unconverted) balance per currency',
|
|
1344
|
+
type: 'array',
|
|
1345
|
+
items: {
|
|
1346
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
1347
|
+
}
|
|
1348
|
+
},
|
|
1349
|
+
warnings: {
|
|
1350
|
+
description: 'Currencies missing an FX rate (omitted when empty)',
|
|
1351
|
+
type: 'array',
|
|
1352
|
+
items: {
|
|
1353
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
1354
|
+
}
|
|
1355
|
+
}
|
|
1356
|
+
},
|
|
1357
|
+
required: ['totalAmount', 'currency', 'balanceByCurrency']
|
|
1358
|
+
} as const;
|
|
1359
|
+
|
|
1250
1360
|
export const $TransactionListResponseDto = {
|
|
1251
1361
|
type: 'object',
|
|
1252
1362
|
properties: {
|
|
@@ -1271,6 +1381,15 @@ export const $TransactionListResponseDto = {
|
|
|
1271
1381
|
type: 'number',
|
|
1272
1382
|
description: 'Number of items skipped',
|
|
1273
1383
|
example: 0
|
|
1384
|
+
},
|
|
1385
|
+
summary: {
|
|
1386
|
+
description:
|
|
1387
|
+
'Amount summary for the full filtered set (#514). Present only when the request has a single account OR category viewpoint; omitted for search-only / plain-list / dual-perspective requests.',
|
|
1388
|
+
allOf: [
|
|
1389
|
+
{
|
|
1390
|
+
$ref: '#/components/schemas/TransactionListSummaryDto'
|
|
1391
|
+
}
|
|
1392
|
+
]
|
|
1274
1393
|
}
|
|
1275
1394
|
},
|
|
1276
1395
|
required: ['data', 'total', 'limit', 'offset']
|
|
@@ -1370,7 +1489,7 @@ export const $BalanceResponseDto = {
|
|
|
1370
1489
|
account: {
|
|
1371
1490
|
type: 'string',
|
|
1372
1491
|
description: 'Account name',
|
|
1373
|
-
example: 'Assets:
|
|
1492
|
+
example: 'Assets:Checking'
|
|
1374
1493
|
},
|
|
1375
1494
|
balance: {
|
|
1376
1495
|
type: 'string',
|
|
@@ -1397,7 +1516,7 @@ export const $MultiCurrencyBalanceResponseDto = {
|
|
|
1397
1516
|
account: {
|
|
1398
1517
|
type: 'string',
|
|
1399
1518
|
description: 'Account name',
|
|
1400
|
-
example: 'Assets:
|
|
1519
|
+
example: 'Assets:Checking'
|
|
1401
1520
|
},
|
|
1402
1521
|
balances: {
|
|
1403
1522
|
type: 'object',
|
|
@@ -1453,7 +1572,7 @@ export const $TransactionSummaryDto = {
|
|
|
1453
1572
|
accountName: {
|
|
1454
1573
|
type: 'string',
|
|
1455
1574
|
description: 'Source account name (first posting)',
|
|
1456
|
-
example: 'Assets:
|
|
1575
|
+
example: 'Assets:Checking'
|
|
1457
1576
|
},
|
|
1458
1577
|
sourceType: {
|
|
1459
1578
|
type: 'string',
|
|
@@ -2745,117 +2864,274 @@ export const $UpdateCommodityDto = {
|
|
|
2745
2864
|
}
|
|
2746
2865
|
} as const;
|
|
2747
2866
|
|
|
2748
|
-
export const $
|
|
2867
|
+
export const $CreateBeanPriceDto = {
|
|
2749
2868
|
type: 'object',
|
|
2750
2869
|
properties: {
|
|
2751
|
-
name: {
|
|
2752
|
-
type: 'string',
|
|
2753
|
-
description: 'Rule name (unique per user)',
|
|
2754
|
-
maxLength: 100
|
|
2755
|
-
},
|
|
2756
|
-
icon: {
|
|
2757
|
-
type: 'string',
|
|
2758
|
-
description: 'Icon emoji',
|
|
2759
|
-
maxLength: 10
|
|
2760
|
-
},
|
|
2761
|
-
frequency: {
|
|
2762
|
-
type: 'string',
|
|
2763
|
-
description: 'Recurring frequency',
|
|
2764
|
-
enum: [
|
|
2765
|
-
'WEEKLY',
|
|
2766
|
-
'BIWEEKLY',
|
|
2767
|
-
'MONTHLY',
|
|
2768
|
-
'BIMONTHLY',
|
|
2769
|
-
'QUARTERLY',
|
|
2770
|
-
'YEARLY',
|
|
2771
|
-
'CUSTOM'
|
|
2772
|
-
]
|
|
2773
|
-
},
|
|
2774
|
-
expectedAmount: {
|
|
2775
|
-
type: 'number',
|
|
2776
|
-
description: 'Expected amount (positive number)',
|
|
2777
|
-
minimum: 0
|
|
2778
|
-
},
|
|
2779
|
-
expectedDay: {
|
|
2780
|
-
type: 'number',
|
|
2781
|
-
description: 'Expected day of month (1-31)',
|
|
2782
|
-
minimum: 1,
|
|
2783
|
-
maximum: 31
|
|
2784
|
-
},
|
|
2785
|
-
customIntervalDays: {
|
|
2786
|
-
type: 'number',
|
|
2787
|
-
description: 'Custom interval in days (required for CUSTOM frequency)',
|
|
2788
|
-
minimum: 1
|
|
2789
|
-
},
|
|
2790
2870
|
currency: {
|
|
2791
2871
|
type: 'string',
|
|
2792
|
-
description: 'Currency
|
|
2793
|
-
|
|
2794
|
-
maxLength: 10
|
|
2872
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
2873
|
+
example: 'USD'
|
|
2795
2874
|
},
|
|
2796
|
-
|
|
2875
|
+
quoteCurrency: {
|
|
2797
2876
|
type: 'string',
|
|
2798
|
-
description: '
|
|
2799
|
-
|
|
2877
|
+
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
2878
|
+
example: 'CNY'
|
|
2800
2879
|
},
|
|
2801
|
-
|
|
2880
|
+
amount: {
|
|
2802
2881
|
type: 'number',
|
|
2803
|
-
description:
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
},
|
|
2808
|
-
defaultExpenseAccount: {
|
|
2809
|
-
type: 'string',
|
|
2810
|
-
description: 'Default expense account for auto-create',
|
|
2811
|
-
maxLength: 200
|
|
2812
|
-
},
|
|
2813
|
-
defaultPaymentAccount: {
|
|
2814
|
-
type: 'string',
|
|
2815
|
-
description: 'Default payment account for auto-create',
|
|
2816
|
-
maxLength: 200
|
|
2817
|
-
},
|
|
2818
|
-
defaultPayee: {
|
|
2819
|
-
type: 'string',
|
|
2820
|
-
description: 'Default payee for auto-create',
|
|
2821
|
-
maxLength: 200
|
|
2822
|
-
},
|
|
2823
|
-
autoCreate: {
|
|
2824
|
-
type: 'boolean',
|
|
2825
|
-
description: 'Auto-create transaction when expected date arrives',
|
|
2826
|
-
default: false
|
|
2882
|
+
description:
|
|
2883
|
+
'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
|
|
2884
|
+
example: 175.5,
|
|
2885
|
+
minimum: 0
|
|
2827
2886
|
},
|
|
2828
|
-
|
|
2887
|
+
date: {
|
|
2829
2888
|
type: 'string',
|
|
2830
|
-
description: '
|
|
2889
|
+
description: 'Price date (ISO 8601 format)',
|
|
2890
|
+
example: '2024-11-05'
|
|
2831
2891
|
},
|
|
2832
|
-
|
|
2833
|
-
type: '
|
|
2834
|
-
description:
|
|
2892
|
+
metadata: {
|
|
2893
|
+
type: 'object',
|
|
2894
|
+
description:
|
|
2895
|
+
'Metadata (validated by Zod schema, max field lengths enforced)',
|
|
2896
|
+
example: {
|
|
2897
|
+
source: 'MANUAL',
|
|
2898
|
+
note: 'Bank valuation report',
|
|
2899
|
+
confidence: 0.95
|
|
2900
|
+
}
|
|
2835
2901
|
}
|
|
2836
2902
|
},
|
|
2837
|
-
required: [
|
|
2838
|
-
'name',
|
|
2839
|
-
'frequency',
|
|
2840
|
-
'expectedAmount',
|
|
2841
|
-
'currency',
|
|
2842
|
-
'matchAmountTolerance',
|
|
2843
|
-
'autoCreate'
|
|
2844
|
-
]
|
|
2903
|
+
required: ['currency', 'quoteCurrency', 'amount', 'date']
|
|
2845
2904
|
} as const;
|
|
2846
2905
|
|
|
2847
|
-
export const $
|
|
2906
|
+
export const $PriceResponseDto = {
|
|
2848
2907
|
type: 'object',
|
|
2849
2908
|
properties: {
|
|
2850
2909
|
id: {
|
|
2851
2910
|
type: 'string',
|
|
2852
|
-
description: '
|
|
2911
|
+
description: 'Unique identifier',
|
|
2912
|
+
example: 'uuid-123-456'
|
|
2853
2913
|
},
|
|
2854
2914
|
userId: {
|
|
2855
2915
|
type: 'string',
|
|
2856
|
-
description: 'User ID'
|
|
2916
|
+
description: 'User ID (owner of the price)',
|
|
2917
|
+
example: 'user-123'
|
|
2857
2918
|
},
|
|
2858
|
-
|
|
2919
|
+
currency: {
|
|
2920
|
+
type: 'string',
|
|
2921
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
2922
|
+
example: 'BTC'
|
|
2923
|
+
},
|
|
2924
|
+
quoteCurrency: {
|
|
2925
|
+
type: 'string',
|
|
2926
|
+
description: 'Quote currency (pricing currency, e.g., USD, CNY)',
|
|
2927
|
+
example: 'USD'
|
|
2928
|
+
},
|
|
2929
|
+
amount: {
|
|
2930
|
+
type: 'number',
|
|
2931
|
+
description:
|
|
2932
|
+
'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
|
|
2933
|
+
example: 50000
|
|
2934
|
+
},
|
|
2935
|
+
date: {
|
|
2936
|
+
type: 'string',
|
|
2937
|
+
description:
|
|
2938
|
+
'Price date (ISO 8601 format). Represents the date this price was valid.',
|
|
2939
|
+
example: '2024-01-01',
|
|
2940
|
+
format: 'date'
|
|
2941
|
+
},
|
|
2942
|
+
meta: {
|
|
2943
|
+
type: 'object',
|
|
2944
|
+
description:
|
|
2945
|
+
'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
|
|
2946
|
+
example: {
|
|
2947
|
+
source: 'MANUAL',
|
|
2948
|
+
note: 'User-defined price',
|
|
2949
|
+
confidence: 1
|
|
2950
|
+
}
|
|
2951
|
+
},
|
|
2952
|
+
createdAt: {
|
|
2953
|
+
format: 'date-time',
|
|
2954
|
+
type: 'string',
|
|
2955
|
+
description: 'Creation timestamp',
|
|
2956
|
+
example: '2024-11-03T10:00:00Z'
|
|
2957
|
+
},
|
|
2958
|
+
updatedAt: {
|
|
2959
|
+
format: 'date-time',
|
|
2960
|
+
type: 'string',
|
|
2961
|
+
description: 'Last update timestamp',
|
|
2962
|
+
example: '2024-11-03T10:00:00Z'
|
|
2963
|
+
}
|
|
2964
|
+
},
|
|
2965
|
+
required: [
|
|
2966
|
+
'id',
|
|
2967
|
+
'userId',
|
|
2968
|
+
'currency',
|
|
2969
|
+
'quoteCurrency',
|
|
2970
|
+
'amount',
|
|
2971
|
+
'date',
|
|
2972
|
+
'meta',
|
|
2973
|
+
'createdAt',
|
|
2974
|
+
'updatedAt'
|
|
2975
|
+
]
|
|
2976
|
+
} as const;
|
|
2977
|
+
|
|
2978
|
+
export const $PriceListResponseDto = {
|
|
2979
|
+
type: 'object',
|
|
2980
|
+
properties: {
|
|
2981
|
+
items: {
|
|
2982
|
+
description: 'List of prices',
|
|
2983
|
+
type: 'array',
|
|
2984
|
+
items: {
|
|
2985
|
+
$ref: '#/components/schemas/PriceResponseDto'
|
|
2986
|
+
}
|
|
2987
|
+
},
|
|
2988
|
+
total: {
|
|
2989
|
+
type: 'number',
|
|
2990
|
+
description: 'Total number of prices',
|
|
2991
|
+
example: 42
|
|
2992
|
+
}
|
|
2993
|
+
},
|
|
2994
|
+
required: ['items', 'total']
|
|
2995
|
+
} as const;
|
|
2996
|
+
|
|
2997
|
+
export const $UpdateBeanPriceDto = {
|
|
2998
|
+
type: 'object',
|
|
2999
|
+
properties: {
|
|
3000
|
+
currency: {
|
|
3001
|
+
type: 'string',
|
|
3002
|
+
description: 'Currency being priced'
|
|
3003
|
+
},
|
|
3004
|
+
quoteCurrency: {
|
|
3005
|
+
type: 'string',
|
|
3006
|
+
description: 'Quote currency (pricing currency)'
|
|
3007
|
+
},
|
|
3008
|
+
amount: {
|
|
3009
|
+
type: 'number',
|
|
3010
|
+
description: 'Price amount (MUST be >= 0 per Beancount spec)',
|
|
3011
|
+
minimum: 0
|
|
3012
|
+
},
|
|
3013
|
+
date: {
|
|
3014
|
+
type: 'string',
|
|
3015
|
+
description: 'Price date (ISO 8601 format)'
|
|
3016
|
+
},
|
|
3017
|
+
metadata: {
|
|
3018
|
+
type: 'object',
|
|
3019
|
+
description: 'Metadata'
|
|
3020
|
+
}
|
|
3021
|
+
}
|
|
3022
|
+
} as const;
|
|
3023
|
+
|
|
3024
|
+
export const $CreateRecurringRuleDto = {
|
|
3025
|
+
type: 'object',
|
|
3026
|
+
properties: {
|
|
3027
|
+
name: {
|
|
3028
|
+
type: 'string',
|
|
3029
|
+
description: 'Rule name (unique per user)',
|
|
3030
|
+
maxLength: 100
|
|
3031
|
+
},
|
|
3032
|
+
icon: {
|
|
3033
|
+
type: 'string',
|
|
3034
|
+
description: 'Icon emoji',
|
|
3035
|
+
maxLength: 10
|
|
3036
|
+
},
|
|
3037
|
+
frequency: {
|
|
3038
|
+
type: 'string',
|
|
3039
|
+
description: 'Recurring frequency',
|
|
3040
|
+
enum: [
|
|
3041
|
+
'WEEKLY',
|
|
3042
|
+
'BIWEEKLY',
|
|
3043
|
+
'MONTHLY',
|
|
3044
|
+
'BIMONTHLY',
|
|
3045
|
+
'QUARTERLY',
|
|
3046
|
+
'YEARLY',
|
|
3047
|
+
'CUSTOM'
|
|
3048
|
+
]
|
|
3049
|
+
},
|
|
3050
|
+
expectedAmount: {
|
|
3051
|
+
type: 'number',
|
|
3052
|
+
description: 'Expected amount (positive number)',
|
|
3053
|
+
minimum: 0
|
|
3054
|
+
},
|
|
3055
|
+
expectedDay: {
|
|
3056
|
+
type: 'number',
|
|
3057
|
+
description: 'Expected day of month (1-31)',
|
|
3058
|
+
minimum: 1,
|
|
3059
|
+
maximum: 31
|
|
3060
|
+
},
|
|
3061
|
+
customIntervalDays: {
|
|
3062
|
+
type: 'number',
|
|
3063
|
+
description: 'Custom interval in days (required for CUSTOM frequency)',
|
|
3064
|
+
minimum: 1
|
|
3065
|
+
},
|
|
3066
|
+
currency: {
|
|
3067
|
+
type: 'string',
|
|
3068
|
+
description: 'Currency code',
|
|
3069
|
+
default: 'CNY',
|
|
3070
|
+
maxLength: 10
|
|
3071
|
+
},
|
|
3072
|
+
matchPayeePattern: {
|
|
3073
|
+
type: 'string',
|
|
3074
|
+
description: 'Payee matching pattern (supports wildcards)',
|
|
3075
|
+
maxLength: 200
|
|
3076
|
+
},
|
|
3077
|
+
matchAmountTolerance: {
|
|
3078
|
+
type: 'number',
|
|
3079
|
+
description: 'Amount tolerance percentage (0-1)',
|
|
3080
|
+
default: 0.075,
|
|
3081
|
+
minimum: 0,
|
|
3082
|
+
maximum: 1
|
|
3083
|
+
},
|
|
3084
|
+
defaultExpenseAccount: {
|
|
3085
|
+
type: 'string',
|
|
3086
|
+
description: 'Default expense account for auto-create',
|
|
3087
|
+
maxLength: 200
|
|
3088
|
+
},
|
|
3089
|
+
defaultPaymentAccount: {
|
|
3090
|
+
type: 'string',
|
|
3091
|
+
description: 'Default payment account for auto-create',
|
|
3092
|
+
maxLength: 200
|
|
3093
|
+
},
|
|
3094
|
+
defaultPayee: {
|
|
3095
|
+
type: 'string',
|
|
3096
|
+
description: 'Default payee for auto-create',
|
|
3097
|
+
maxLength: 200
|
|
3098
|
+
},
|
|
3099
|
+
autoCreate: {
|
|
3100
|
+
type: 'boolean',
|
|
3101
|
+
description: 'Auto-create transaction when expected date arrives',
|
|
3102
|
+
default: false
|
|
3103
|
+
},
|
|
3104
|
+
startDate: {
|
|
3105
|
+
type: 'string',
|
|
3106
|
+
description: 'Rule start date (ISO format)'
|
|
3107
|
+
},
|
|
3108
|
+
endDate: {
|
|
3109
|
+
type: 'string',
|
|
3110
|
+
description: 'Rule end date (ISO format)'
|
|
3111
|
+
}
|
|
3112
|
+
},
|
|
3113
|
+
required: [
|
|
3114
|
+
'name',
|
|
3115
|
+
'frequency',
|
|
3116
|
+
'expectedAmount',
|
|
3117
|
+
'currency',
|
|
3118
|
+
'matchAmountTolerance',
|
|
3119
|
+
'autoCreate'
|
|
3120
|
+
]
|
|
3121
|
+
} as const;
|
|
3122
|
+
|
|
3123
|
+
export const $RecurringRuleResponseDto = {
|
|
3124
|
+
type: 'object',
|
|
3125
|
+
properties: {
|
|
3126
|
+
id: {
|
|
3127
|
+
type: 'string',
|
|
3128
|
+
description: 'Rule ID'
|
|
3129
|
+
},
|
|
3130
|
+
userId: {
|
|
3131
|
+
type: 'string',
|
|
3132
|
+
description: 'User ID'
|
|
3133
|
+
},
|
|
3134
|
+
name: {
|
|
2859
3135
|
type: 'string',
|
|
2860
3136
|
description: 'Rule name'
|
|
2861
3137
|
},
|
|
@@ -3516,30 +3792,477 @@ export const $ForecastResponseDto = {
|
|
|
3516
3792
|
]
|
|
3517
3793
|
} as const;
|
|
3518
3794
|
|
|
3519
|
-
export const $
|
|
3795
|
+
export const $CurrencyBalanceDto = {
|
|
3520
3796
|
type: 'object',
|
|
3521
3797
|
properties: {
|
|
3522
|
-
|
|
3798
|
+
currency: {
|
|
3523
3799
|
type: 'string',
|
|
3524
|
-
|
|
3525
|
-
|
|
3800
|
+
description: 'ISO 4217 currency code',
|
|
3801
|
+
example: 'CNY'
|
|
3526
3802
|
},
|
|
3527
|
-
|
|
3803
|
+
balance: {
|
|
3528
3804
|
type: 'string',
|
|
3529
|
-
|
|
3805
|
+
description: 'Balance amount',
|
|
3806
|
+
example: '500000.00'
|
|
3807
|
+
}
|
|
3808
|
+
},
|
|
3809
|
+
required: ['currency', 'balance']
|
|
3810
|
+
} as const;
|
|
3811
|
+
|
|
3812
|
+
export const $TimeSeriesPointDto = {
|
|
3813
|
+
type: 'object',
|
|
3814
|
+
properties: {
|
|
3815
|
+
date: {
|
|
3816
|
+
type: 'string',
|
|
3817
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3818
|
+
example: '2024-06-15'
|
|
3530
3819
|
},
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
maxItems: 50,
|
|
3536
|
-
type: 'array'
|
|
3820
|
+
value: {
|
|
3821
|
+
type: 'string',
|
|
3822
|
+
description: 'Value at this date (in base currency)',
|
|
3823
|
+
example: '500000.00'
|
|
3537
3824
|
},
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
|
|
3825
|
+
change: {
|
|
3826
|
+
type: 'object',
|
|
3827
|
+
description: 'Change from previous point',
|
|
3828
|
+
example: '5000.00'
|
|
3829
|
+
},
|
|
3830
|
+
assets: {
|
|
3831
|
+
type: 'string',
|
|
3832
|
+
description: 'Total assets at this date (in base currency)',
|
|
3833
|
+
example: '494338.00'
|
|
3834
|
+
},
|
|
3835
|
+
liabilities: {
|
|
3836
|
+
type: 'string',
|
|
3837
|
+
description: 'Total liabilities at this date (in base currency)',
|
|
3838
|
+
example: '310098.00'
|
|
3839
|
+
},
|
|
3840
|
+
byCurrency: {
|
|
3841
|
+
description: 'Multi-currency breakdown for this point',
|
|
3842
|
+
type: 'array',
|
|
3843
|
+
items: {
|
|
3844
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3845
|
+
}
|
|
3846
|
+
}
|
|
3847
|
+
},
|
|
3848
|
+
required: ['date', 'value']
|
|
3849
|
+
} as const;
|
|
3850
|
+
|
|
3851
|
+
export const $TrendSummaryDto = {
|
|
3852
|
+
type: 'object',
|
|
3853
|
+
properties: {
|
|
3854
|
+
startValue: {
|
|
3855
|
+
type: 'string',
|
|
3856
|
+
description: 'Value at start of period',
|
|
3857
|
+
example: '450000.00'
|
|
3858
|
+
},
|
|
3859
|
+
endValue: {
|
|
3860
|
+
type: 'string',
|
|
3861
|
+
description: 'Value at end of period',
|
|
3862
|
+
example: '500000.00'
|
|
3863
|
+
},
|
|
3864
|
+
totalChange: {
|
|
3865
|
+
type: 'string',
|
|
3866
|
+
description: 'Total change over period',
|
|
3867
|
+
example: '50000.00'
|
|
3868
|
+
},
|
|
3869
|
+
totalChangePercentage: {
|
|
3870
|
+
type: 'string',
|
|
3871
|
+
description: 'Total change percentage',
|
|
3872
|
+
example: '+11.11%'
|
|
3873
|
+
}
|
|
3874
|
+
},
|
|
3875
|
+
required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
|
|
3876
|
+
} as const;
|
|
3877
|
+
|
|
3878
|
+
export const $MultiCurrencyPointDto = {
|
|
3879
|
+
type: 'object',
|
|
3880
|
+
properties: {
|
|
3881
|
+
date: {
|
|
3882
|
+
type: 'string',
|
|
3883
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3884
|
+
example: '2024-06-15'
|
|
3885
|
+
},
|
|
3886
|
+
byCurrency: {
|
|
3887
|
+
description: 'Balances by currency',
|
|
3888
|
+
type: 'array',
|
|
3889
|
+
items: {
|
|
3890
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3891
|
+
}
|
|
3892
|
+
}
|
|
3893
|
+
},
|
|
3894
|
+
required: ['date', 'byCurrency']
|
|
3895
|
+
} as const;
|
|
3896
|
+
|
|
3897
|
+
export const $PortfolioTrendsResponseDto = {
|
|
3898
|
+
type: 'object',
|
|
3899
|
+
properties: {
|
|
3900
|
+
series: {
|
|
3901
|
+
description: 'Time series data points',
|
|
3902
|
+
type: 'array',
|
|
3903
|
+
items: {
|
|
3904
|
+
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
3905
|
+
}
|
|
3906
|
+
},
|
|
3907
|
+
summary: {
|
|
3908
|
+
description: 'Period summary',
|
|
3909
|
+
allOf: [
|
|
3910
|
+
{
|
|
3911
|
+
$ref: '#/components/schemas/TrendSummaryDto'
|
|
3912
|
+
}
|
|
3913
|
+
]
|
|
3914
|
+
},
|
|
3915
|
+
period: {
|
|
3916
|
+
type: 'string',
|
|
3917
|
+
description: 'Period requested',
|
|
3918
|
+
example: '6m'
|
|
3919
|
+
},
|
|
3920
|
+
granularity: {
|
|
3921
|
+
type: 'string',
|
|
3922
|
+
description: 'Data granularity',
|
|
3923
|
+
example: 'month'
|
|
3924
|
+
},
|
|
3925
|
+
currency: {
|
|
3926
|
+
type: 'string',
|
|
3927
|
+
description: 'Base currency for converted values',
|
|
3928
|
+
example: 'CNY'
|
|
3929
|
+
},
|
|
3930
|
+
byCurrency: {
|
|
3931
|
+
description:
|
|
3932
|
+
'Multi-currency time series (each point has currency breakdown)',
|
|
3933
|
+
type: 'array',
|
|
3934
|
+
items: {
|
|
3935
|
+
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
3936
|
+
}
|
|
3937
|
+
},
|
|
3938
|
+
warnings: {
|
|
3939
|
+
description: 'Exchange rate warnings',
|
|
3940
|
+
type: 'array',
|
|
3941
|
+
items: {
|
|
3942
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
3943
|
+
}
|
|
3944
|
+
}
|
|
3945
|
+
},
|
|
3946
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
3947
|
+
} as const;
|
|
3948
|
+
|
|
3949
|
+
export const $CashFlowPointDto = {
|
|
3950
|
+
type: 'object',
|
|
3951
|
+
properties: {
|
|
3952
|
+
month: {
|
|
3953
|
+
type: 'string',
|
|
3954
|
+
description: 'Month key (YYYY-MM)',
|
|
3955
|
+
example: '2024-03'
|
|
3956
|
+
},
|
|
3957
|
+
income: {
|
|
3958
|
+
type: 'string',
|
|
3959
|
+
description: 'Income in base currency (absolute, converted)',
|
|
3960
|
+
example: '10000.00'
|
|
3961
|
+
},
|
|
3962
|
+
expense: {
|
|
3963
|
+
type: 'string',
|
|
3964
|
+
description: 'Expense in base currency (absolute, converted)',
|
|
3965
|
+
example: '5000.00'
|
|
3966
|
+
},
|
|
3967
|
+
netSavings: {
|
|
3968
|
+
type: 'string',
|
|
3969
|
+
description: 'netSavings = income − expense (savings positive)',
|
|
3970
|
+
example: '5000.00'
|
|
3971
|
+
}
|
|
3972
|
+
},
|
|
3973
|
+
required: ['month', 'income', 'expense', 'netSavings']
|
|
3974
|
+
} as const;
|
|
3975
|
+
|
|
3976
|
+
export const $CashFlowTrendSummaryDto = {
|
|
3977
|
+
type: 'object',
|
|
3978
|
+
properties: {
|
|
3979
|
+
totalIncome: {
|
|
3980
|
+
type: 'string',
|
|
3981
|
+
description: 'Total income across the period',
|
|
3982
|
+
example: '60000.00'
|
|
3983
|
+
},
|
|
3984
|
+
totalExpense: {
|
|
3985
|
+
type: 'string',
|
|
3986
|
+
description: 'Total expense across the period',
|
|
3987
|
+
example: '30000.00'
|
|
3988
|
+
},
|
|
3989
|
+
totalNetSavings: {
|
|
3990
|
+
type: 'string',
|
|
3991
|
+
description: 'income − expense across the period',
|
|
3992
|
+
example: '30000.00'
|
|
3993
|
+
},
|
|
3994
|
+
averageMonthlyNetSavings: {
|
|
3995
|
+
type: 'string',
|
|
3996
|
+
description:
|
|
3997
|
+
'totalNetSavings divided by the window length (N months, incl. zero-filled)',
|
|
3998
|
+
example: '5000.00'
|
|
3999
|
+
}
|
|
4000
|
+
},
|
|
4001
|
+
required: [
|
|
4002
|
+
'totalIncome',
|
|
4003
|
+
'totalExpense',
|
|
4004
|
+
'totalNetSavings',
|
|
4005
|
+
'averageMonthlyNetSavings'
|
|
4006
|
+
]
|
|
4007
|
+
} as const;
|
|
4008
|
+
|
|
4009
|
+
export const $CashFlowTrendsResponseDto = {
|
|
4010
|
+
type: 'object',
|
|
4011
|
+
properties: {
|
|
4012
|
+
series: {
|
|
4013
|
+
description:
|
|
4014
|
+
'Monthly cash-flow series (fixed N-month window, zero-filled)',
|
|
4015
|
+
type: 'array',
|
|
4016
|
+
items: {
|
|
4017
|
+
$ref: '#/components/schemas/CashFlowPointDto'
|
|
4018
|
+
}
|
|
4019
|
+
},
|
|
4020
|
+
summary: {
|
|
4021
|
+
description: 'Period totals',
|
|
4022
|
+
allOf: [
|
|
4023
|
+
{
|
|
4024
|
+
$ref: '#/components/schemas/CashFlowTrendSummaryDto'
|
|
4025
|
+
}
|
|
4026
|
+
]
|
|
4027
|
+
},
|
|
4028
|
+
period: {
|
|
4029
|
+
type: 'string',
|
|
4030
|
+
description: 'Period requested',
|
|
4031
|
+
example: '6m'
|
|
4032
|
+
},
|
|
4033
|
+
granularity: {
|
|
4034
|
+
type: 'string',
|
|
4035
|
+
description: 'Data granularity (v1 returns month buckets)',
|
|
4036
|
+
example: 'month'
|
|
4037
|
+
},
|
|
4038
|
+
currency: {
|
|
4039
|
+
type: 'string',
|
|
4040
|
+
description: 'Base currency for converted values',
|
|
4041
|
+
example: 'CNY'
|
|
4042
|
+
},
|
|
4043
|
+
warnings: {
|
|
4044
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
4045
|
+
type: 'array',
|
|
4046
|
+
items: {
|
|
4047
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
4048
|
+
}
|
|
4049
|
+
}
|
|
4050
|
+
},
|
|
4051
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
4052
|
+
} as const;
|
|
4053
|
+
|
|
4054
|
+
export const $GenerateSnapshotBody = {
|
|
4055
|
+
type: 'object',
|
|
4056
|
+
properties: {}
|
|
4057
|
+
} as const;
|
|
4058
|
+
|
|
4059
|
+
export const $GenerateSnapshotResponse = {
|
|
4060
|
+
type: 'object',
|
|
4061
|
+
properties: {}
|
|
4062
|
+
} as const;
|
|
4063
|
+
|
|
4064
|
+
export const $BackfillSnapshotsBody = {
|
|
4065
|
+
type: 'object',
|
|
4066
|
+
properties: {}
|
|
4067
|
+
} as const;
|
|
4068
|
+
|
|
4069
|
+
export const $BackfillSnapshotsResponse = {
|
|
4070
|
+
type: 'object',
|
|
4071
|
+
properties: {}
|
|
4072
|
+
} as const;
|
|
4073
|
+
|
|
4074
|
+
export const $DeleteOwnUserDto = {
|
|
4075
|
+
type: 'object',
|
|
4076
|
+
properties: {
|
|
4077
|
+
accessToken: {
|
|
4078
|
+
type: 'string',
|
|
4079
|
+
description: 'Access token for user verification',
|
|
4080
|
+
example: 'abc123xyz'
|
|
4081
|
+
}
|
|
4082
|
+
},
|
|
4083
|
+
required: ['accessToken']
|
|
4084
|
+
} as const;
|
|
4085
|
+
|
|
4086
|
+
export const $SignupDto = {
|
|
4087
|
+
type: 'object',
|
|
4088
|
+
properties: {
|
|
4089
|
+
turnstileToken: {
|
|
4090
|
+
type: 'string',
|
|
4091
|
+
description:
|
|
4092
|
+
'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
|
|
4093
|
+
example: '0.abc123def456...'
|
|
4094
|
+
}
|
|
4095
|
+
}
|
|
4096
|
+
} as const;
|
|
4097
|
+
|
|
4098
|
+
export const $SignupResponseDto = {
|
|
4099
|
+
type: 'object',
|
|
4100
|
+
properties: {
|
|
4101
|
+
authToken: {
|
|
4102
|
+
type: 'string',
|
|
4103
|
+
description: 'JWT auth token',
|
|
4104
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
4105
|
+
},
|
|
4106
|
+
accessToken: {
|
|
4107
|
+
type: 'string',
|
|
4108
|
+
description: 'Auto-generated access token'
|
|
4109
|
+
},
|
|
4110
|
+
role: {
|
|
4111
|
+
type: 'string',
|
|
4112
|
+
description: 'Assigned user role',
|
|
4113
|
+
enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
|
|
4114
|
+
}
|
|
4115
|
+
},
|
|
4116
|
+
required: ['authToken', 'accessToken', 'role']
|
|
4117
|
+
} as const;
|
|
4118
|
+
|
|
4119
|
+
export const $UpdateUserSettingDto = {
|
|
4120
|
+
type: 'object',
|
|
4121
|
+
properties: {
|
|
4122
|
+
secId: {
|
|
4123
|
+
type: 'number',
|
|
4124
|
+
description: 'Security ID'
|
|
4125
|
+
},
|
|
4126
|
+
annualInterestRate: {
|
|
4127
|
+
type: 'number',
|
|
4128
|
+
description: 'Annual interest rate',
|
|
4129
|
+
example: 0.05
|
|
4130
|
+
},
|
|
4131
|
+
currency: {
|
|
4132
|
+
type: 'string',
|
|
4133
|
+
description: 'Currency code',
|
|
4134
|
+
example: 'USD'
|
|
4135
|
+
},
|
|
4136
|
+
baseCurrency: {
|
|
4137
|
+
type: 'string',
|
|
4138
|
+
description: 'Base currency code',
|
|
4139
|
+
example: 'USD'
|
|
4140
|
+
},
|
|
4141
|
+
benchmark: {
|
|
4142
|
+
type: 'string',
|
|
4143
|
+
description: 'Benchmark symbol',
|
|
4144
|
+
example: 'SPY'
|
|
4145
|
+
},
|
|
4146
|
+
colorScheme: {
|
|
4147
|
+
type: 'string',
|
|
4148
|
+
description: 'Color scheme',
|
|
4149
|
+
enum: ['DARK', 'LIGHT']
|
|
4150
|
+
},
|
|
4151
|
+
dateRange: {
|
|
4152
|
+
type: 'string',
|
|
4153
|
+
description: 'Date range filter',
|
|
4154
|
+
example: '1y'
|
|
4155
|
+
},
|
|
4156
|
+
emergencyFund: {
|
|
4157
|
+
type: 'number',
|
|
4158
|
+
description: 'Emergency fund amount',
|
|
4159
|
+
example: 10000
|
|
4160
|
+
},
|
|
4161
|
+
'filters.accounts': {
|
|
4162
|
+
description: 'Account filter IDs',
|
|
4163
|
+
type: 'array',
|
|
4164
|
+
items: {
|
|
4165
|
+
type: 'string'
|
|
4166
|
+
}
|
|
4167
|
+
},
|
|
4168
|
+
'filters.assetClasses': {
|
|
4169
|
+
description: 'Asset class filters',
|
|
4170
|
+
type: 'array',
|
|
4171
|
+
items: {
|
|
4172
|
+
type: 'string'
|
|
4173
|
+
}
|
|
4174
|
+
},
|
|
4175
|
+
'filters.dataSource': {
|
|
4176
|
+
type: 'string',
|
|
4177
|
+
description: 'Data source filter'
|
|
4178
|
+
},
|
|
4179
|
+
'filters.symbol': {
|
|
4180
|
+
type: 'string',
|
|
4181
|
+
description: 'Symbol filter'
|
|
4182
|
+
},
|
|
4183
|
+
'filters.tags': {
|
|
4184
|
+
description: 'Tag filters',
|
|
4185
|
+
type: 'array',
|
|
4186
|
+
items: {
|
|
4187
|
+
type: 'string'
|
|
4188
|
+
}
|
|
4189
|
+
},
|
|
4190
|
+
isExperimentalFeatures: {
|
|
4191
|
+
type: 'boolean',
|
|
4192
|
+
description: 'Enable experimental features'
|
|
4193
|
+
},
|
|
4194
|
+
isRestrictedView: {
|
|
4195
|
+
type: 'boolean',
|
|
4196
|
+
description: 'Enable restricted view mode'
|
|
4197
|
+
},
|
|
4198
|
+
language: {
|
|
4199
|
+
type: 'string',
|
|
4200
|
+
description: 'Language code',
|
|
4201
|
+
example: 'en'
|
|
4202
|
+
},
|
|
4203
|
+
locale: {
|
|
4204
|
+
type: 'string',
|
|
4205
|
+
description: 'Locale code',
|
|
4206
|
+
example: 'en-US'
|
|
4207
|
+
},
|
|
4208
|
+
projectedTotalAmount: {
|
|
4209
|
+
type: 'number',
|
|
4210
|
+
description: 'Projected total amount',
|
|
4211
|
+
example: 1000000
|
|
4212
|
+
},
|
|
4213
|
+
retirementDate: {
|
|
4214
|
+
type: 'string',
|
|
4215
|
+
description: 'Retirement date in ISO 8601 format',
|
|
4216
|
+
example: '2050-01-01'
|
|
4217
|
+
},
|
|
4218
|
+
savingsRate: {
|
|
4219
|
+
type: 'number',
|
|
4220
|
+
description: 'Savings rate percentage',
|
|
4221
|
+
example: 0.2
|
|
4222
|
+
},
|
|
4223
|
+
viewMode: {
|
|
4224
|
+
type: 'string',
|
|
4225
|
+
description: 'View mode',
|
|
4226
|
+
enum: ['DEFAULT', 'ZEN']
|
|
4227
|
+
}
|
|
4228
|
+
}
|
|
4229
|
+
} as const;
|
|
4230
|
+
|
|
4231
|
+
export const $UpdatePropertyDto = {
|
|
4232
|
+
type: 'object',
|
|
4233
|
+
properties: {
|
|
4234
|
+
value: {
|
|
4235
|
+
type: 'string',
|
|
4236
|
+
description: 'Property value'
|
|
4237
|
+
}
|
|
4238
|
+
},
|
|
4239
|
+
required: ['value']
|
|
4240
|
+
} as const;
|
|
4241
|
+
|
|
4242
|
+
export const $CreateTransactionRuleDto = {
|
|
4243
|
+
type: 'object',
|
|
4244
|
+
properties: {
|
|
4245
|
+
name: {
|
|
4246
|
+
type: 'string',
|
|
4247
|
+
minLength: 1,
|
|
4248
|
+
maxLength: 100
|
|
4249
|
+
},
|
|
4250
|
+
description: {
|
|
4251
|
+
type: 'string',
|
|
4252
|
+
maxLength: 500
|
|
4253
|
+
},
|
|
4254
|
+
narrationKeywords: {
|
|
4255
|
+
items: {
|
|
4256
|
+
type: 'array'
|
|
4257
|
+
},
|
|
4258
|
+
maxItems: 50,
|
|
4259
|
+
type: 'array'
|
|
4260
|
+
},
|
|
4261
|
+
payeeKeywords: {
|
|
4262
|
+
items: {
|
|
4263
|
+
type: 'array'
|
|
4264
|
+
},
|
|
4265
|
+
maxItems: 50,
|
|
3543
4266
|
type: 'array'
|
|
3544
4267
|
},
|
|
3545
4268
|
categoryKeywords: {
|
|
@@ -4165,151 +4888,393 @@ export const $TestRuleResponseDto = {
|
|
|
4165
4888
|
required: ['ruleId', 'matches', 'confidence', 'matchDetails']
|
|
4166
4889
|
} as const;
|
|
4167
4890
|
|
|
4168
|
-
export const $
|
|
4891
|
+
export const $CreateBeanEventDto = {
|
|
4169
4892
|
type: 'object',
|
|
4170
4893
|
properties: {
|
|
4171
|
-
|
|
4894
|
+
date: {
|
|
4172
4895
|
type: 'string',
|
|
4173
|
-
description: '
|
|
4174
|
-
example: '
|
|
4896
|
+
description: 'Life event date (ISO 8601)',
|
|
4897
|
+
example: '2024-03-15'
|
|
4898
|
+
},
|
|
4899
|
+
type: {
|
|
4900
|
+
type: 'string',
|
|
4901
|
+
description:
|
|
4902
|
+
'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
|
|
4903
|
+
example: 'employer'
|
|
4904
|
+
},
|
|
4905
|
+
description: {
|
|
4906
|
+
type: 'string',
|
|
4907
|
+
description:
|
|
4908
|
+
'Life event description. Empty string is a VALID value (distinct from absence).',
|
|
4909
|
+
example: 'Acme Corp'
|
|
4910
|
+
},
|
|
4911
|
+
meta: {
|
|
4912
|
+
type: 'object',
|
|
4913
|
+
description:
|
|
4914
|
+
'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
|
|
4915
|
+
example: {
|
|
4916
|
+
note: 'Promotion'
|
|
4917
|
+
}
|
|
4175
4918
|
}
|
|
4176
4919
|
},
|
|
4177
|
-
required: ['
|
|
4920
|
+
required: ['date', 'type', 'description']
|
|
4178
4921
|
} as const;
|
|
4179
4922
|
|
|
4180
|
-
export const $
|
|
4923
|
+
export const $EventResponseDto = {
|
|
4181
4924
|
type: 'object',
|
|
4182
4925
|
properties: {
|
|
4183
|
-
|
|
4926
|
+
id: {
|
|
4927
|
+
type: 'string',
|
|
4928
|
+
description: 'Unique identifier',
|
|
4929
|
+
example: 'uuid-123-456'
|
|
4930
|
+
},
|
|
4931
|
+
userId: {
|
|
4932
|
+
type: 'string',
|
|
4933
|
+
description: 'User ID (owner of the life event)',
|
|
4934
|
+
example: 'user-123'
|
|
4935
|
+
},
|
|
4936
|
+
date: {
|
|
4937
|
+
type: 'string',
|
|
4938
|
+
description: 'Life event date (ISO 8601 format)',
|
|
4939
|
+
example: '2024-03-15',
|
|
4940
|
+
format: 'date'
|
|
4941
|
+
},
|
|
4942
|
+
type: {
|
|
4184
4943
|
type: 'string',
|
|
4185
4944
|
description:
|
|
4186
|
-
'
|
|
4187
|
-
example: '
|
|
4945
|
+
'Life event type (user-defined, e.g., "employer", "location")',
|
|
4946
|
+
example: 'employer'
|
|
4947
|
+
},
|
|
4948
|
+
description: {
|
|
4949
|
+
type: 'string',
|
|
4950
|
+
description:
|
|
4951
|
+
'Life event description. May be an empty string (a valid value distinct from absence).',
|
|
4952
|
+
example: 'Acme Corp'
|
|
4953
|
+
},
|
|
4954
|
+
meta: {
|
|
4955
|
+
type: 'object',
|
|
4956
|
+
description: 'Product-side metadata (free-form JSON)',
|
|
4957
|
+
example: {
|
|
4958
|
+
note: 'Promotion'
|
|
4959
|
+
}
|
|
4960
|
+
},
|
|
4961
|
+
createdAt: {
|
|
4962
|
+
format: 'date-time',
|
|
4963
|
+
type: 'string',
|
|
4964
|
+
description: 'Creation timestamp',
|
|
4965
|
+
example: '2024-03-15T10:00:00Z'
|
|
4966
|
+
},
|
|
4967
|
+
updatedAt: {
|
|
4968
|
+
format: 'date-time',
|
|
4969
|
+
type: 'string',
|
|
4970
|
+
description:
|
|
4971
|
+
'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
|
|
4972
|
+
example: '2024-03-15T10:00:00Z'
|
|
4188
4973
|
}
|
|
4189
|
-
}
|
|
4974
|
+
},
|
|
4975
|
+
required: [
|
|
4976
|
+
'id',
|
|
4977
|
+
'userId',
|
|
4978
|
+
'date',
|
|
4979
|
+
'type',
|
|
4980
|
+
'description',
|
|
4981
|
+
'meta',
|
|
4982
|
+
'createdAt',
|
|
4983
|
+
'updatedAt'
|
|
4984
|
+
]
|
|
4190
4985
|
} as const;
|
|
4191
4986
|
|
|
4192
|
-
export const $
|
|
4987
|
+
export const $EventListResponseDto = {
|
|
4193
4988
|
type: 'object',
|
|
4194
4989
|
properties: {
|
|
4195
|
-
|
|
4196
|
-
|
|
4197
|
-
|
|
4990
|
+
items: {
|
|
4991
|
+
description: 'List of life events',
|
|
4992
|
+
type: 'array',
|
|
4993
|
+
items: {
|
|
4994
|
+
$ref: '#/components/schemas/EventResponseDto'
|
|
4995
|
+
}
|
|
4198
4996
|
},
|
|
4199
|
-
|
|
4997
|
+
total: {
|
|
4200
4998
|
type: 'number',
|
|
4201
|
-
description: '
|
|
4202
|
-
example:
|
|
4999
|
+
description: 'Total number of life events matching the query',
|
|
5000
|
+
example: 42
|
|
5001
|
+
}
|
|
5002
|
+
},
|
|
5003
|
+
required: ['items', 'total']
|
|
5004
|
+
} as const;
|
|
5005
|
+
|
|
5006
|
+
export const $UpdateBeanEventDto = {
|
|
5007
|
+
type: 'object',
|
|
5008
|
+
properties: {
|
|
5009
|
+
date: {
|
|
5010
|
+
type: 'string',
|
|
5011
|
+
description: 'Life event date (ISO 8601)'
|
|
5012
|
+
},
|
|
5013
|
+
type: {
|
|
5014
|
+
type: 'string',
|
|
5015
|
+
description: 'Life event type (user-defined)'
|
|
5016
|
+
},
|
|
5017
|
+
description: {
|
|
5018
|
+
type: 'string',
|
|
5019
|
+
description:
|
|
5020
|
+
'Life event description. Empty string is a VALID value (distinct from absence).'
|
|
5021
|
+
},
|
|
5022
|
+
meta: {
|
|
5023
|
+
type: 'object',
|
|
5024
|
+
description: 'Product-side metadata (free-form JSON)'
|
|
5025
|
+
}
|
|
5026
|
+
}
|
|
5027
|
+
} as const;
|
|
5028
|
+
|
|
5029
|
+
export const $OnboardingAccountDto = {
|
|
5030
|
+
type: 'object',
|
|
5031
|
+
properties: {
|
|
5032
|
+
path: {
|
|
5033
|
+
type: 'string',
|
|
5034
|
+
description:
|
|
5035
|
+
'Account path (Assets/Liabilities only; format validated by the account service)',
|
|
5036
|
+
example: 'Assets:Checking'
|
|
4203
5037
|
},
|
|
4204
5038
|
currency: {
|
|
4205
5039
|
type: 'string',
|
|
4206
|
-
description: '
|
|
5040
|
+
description: 'ISO 4217 currency code (3 letters)',
|
|
4207
5041
|
example: 'USD'
|
|
4208
5042
|
},
|
|
4209
|
-
|
|
5043
|
+
openingBalance: {
|
|
5044
|
+
type: 'string',
|
|
5045
|
+
description:
|
|
5046
|
+
'Opening balance as a non-negative Decimal string (e.g. "1000.00")',
|
|
5047
|
+
example: '1000.00'
|
|
5048
|
+
},
|
|
5049
|
+
platformId: {
|
|
5050
|
+
type: 'string',
|
|
5051
|
+
description:
|
|
5052
|
+
'Platform ID to bind the account to (references Platform.id); omit for unbound',
|
|
5053
|
+
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
5054
|
+
}
|
|
5055
|
+
},
|
|
5056
|
+
required: ['path', 'currency']
|
|
5057
|
+
} as const;
|
|
5058
|
+
|
|
5059
|
+
export const $OnboardingDto = {
|
|
5060
|
+
type: 'object',
|
|
5061
|
+
properties: {
|
|
5062
|
+
accounts: {
|
|
5063
|
+
description: 'Asset/Liability accounts to register with opening balances',
|
|
5064
|
+
type: 'array',
|
|
5065
|
+
items: {
|
|
5066
|
+
$ref: '#/components/schemas/OnboardingAccountDto'
|
|
5067
|
+
}
|
|
5068
|
+
},
|
|
5069
|
+
skipAssetRegistration: {
|
|
5070
|
+
type: 'boolean',
|
|
5071
|
+
description:
|
|
5072
|
+
'Skip asset registration; only bootstrap the core account set',
|
|
5073
|
+
default: false
|
|
5074
|
+
}
|
|
5075
|
+
}
|
|
5076
|
+
} as const;
|
|
5077
|
+
|
|
5078
|
+
export const $ActualBalanceDto = {
|
|
5079
|
+
type: 'object',
|
|
5080
|
+
properties: {
|
|
5081
|
+
amount: {
|
|
5082
|
+
type: 'string',
|
|
5083
|
+
description:
|
|
5084
|
+
'Actual balance amount as a decimal string (preserves precision for tolerance inference).',
|
|
5085
|
+
example: '1234.56'
|
|
5086
|
+
},
|
|
5087
|
+
ccy: {
|
|
5088
|
+
type: 'string',
|
|
5089
|
+
description: 'Currency code (ISO 4217 or commodity ticker).',
|
|
5090
|
+
example: 'CNY'
|
|
5091
|
+
}
|
|
5092
|
+
},
|
|
5093
|
+
required: ['amount', 'ccy']
|
|
5094
|
+
} as const;
|
|
5095
|
+
|
|
5096
|
+
export const $ComputeReconciliationDto = {
|
|
5097
|
+
type: 'object',
|
|
5098
|
+
properties: {
|
|
5099
|
+
accountId: {
|
|
5100
|
+
type: 'string',
|
|
5101
|
+
description: 'BeanAccount id to reconcile.'
|
|
5102
|
+
},
|
|
5103
|
+
asOfDate: {
|
|
5104
|
+
type: 'string',
|
|
5105
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5106
|
+
example: '2026-07-24'
|
|
5107
|
+
},
|
|
5108
|
+
actualBalance: {
|
|
5109
|
+
description: 'Actual balance from the external statement.',
|
|
5110
|
+
allOf: [
|
|
5111
|
+
{
|
|
5112
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5113
|
+
}
|
|
5114
|
+
]
|
|
5115
|
+
}
|
|
5116
|
+
},
|
|
5117
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5118
|
+
} as const;
|
|
5119
|
+
|
|
5120
|
+
export const $ReconciliationComputeResultDto = {
|
|
5121
|
+
type: 'object',
|
|
5122
|
+
properties: {
|
|
5123
|
+
accountId: {
|
|
5124
|
+
type: 'string'
|
|
5125
|
+
},
|
|
5126
|
+
asOfDate: {
|
|
5127
|
+
type: 'string'
|
|
5128
|
+
},
|
|
5129
|
+
bookBalance: {
|
|
5130
|
+
type: 'string',
|
|
5131
|
+
description: 'System-computed book balance (decimal string).'
|
|
5132
|
+
},
|
|
5133
|
+
actualBalance: {
|
|
5134
|
+
type: 'string',
|
|
5135
|
+
description: 'User-entered actual balance (decimal string).'
|
|
5136
|
+
},
|
|
5137
|
+
currency: {
|
|
5138
|
+
type: 'string'
|
|
5139
|
+
},
|
|
5140
|
+
diff: {
|
|
4210
5141
|
type: 'string',
|
|
4211
|
-
description: '
|
|
4212
|
-
example: 'USD'
|
|
5142
|
+
description: 'Diff = book − actual (decimal string).'
|
|
4213
5143
|
},
|
|
4214
|
-
|
|
5144
|
+
tolerance: {
|
|
4215
5145
|
type: 'string',
|
|
4216
|
-
description: '
|
|
4217
|
-
example: 'SPY'
|
|
5146
|
+
description: 'Applied tolerance (decimal string).'
|
|
4218
5147
|
},
|
|
4219
|
-
|
|
5148
|
+
withinTolerance: {
|
|
5149
|
+
type: 'boolean',
|
|
5150
|
+
description: 'true when |diff| ≤ tolerance.'
|
|
5151
|
+
},
|
|
5152
|
+
suggestedAction: {
|
|
4220
5153
|
type: 'string',
|
|
4221
|
-
|
|
4222
|
-
|
|
5154
|
+
enum: ['assert', 'pad'],
|
|
5155
|
+
description:
|
|
5156
|
+
'Suggested next action: assert when within tolerance, pad otherwise.'
|
|
5157
|
+
}
|
|
5158
|
+
},
|
|
5159
|
+
required: [
|
|
5160
|
+
'accountId',
|
|
5161
|
+
'asOfDate',
|
|
5162
|
+
'bookBalance',
|
|
5163
|
+
'actualBalance',
|
|
5164
|
+
'currency',
|
|
5165
|
+
'diff',
|
|
5166
|
+
'tolerance',
|
|
5167
|
+
'withinTolerance',
|
|
5168
|
+
'suggestedAction'
|
|
5169
|
+
]
|
|
5170
|
+
} as const;
|
|
5171
|
+
|
|
5172
|
+
export const $AssertReconciliationDto = {
|
|
5173
|
+
type: 'object',
|
|
5174
|
+
properties: {
|
|
5175
|
+
accountId: {
|
|
5176
|
+
type: 'string',
|
|
5177
|
+
description: 'BeanAccount id to reconcile.'
|
|
4223
5178
|
},
|
|
4224
|
-
|
|
5179
|
+
asOfDate: {
|
|
4225
5180
|
type: 'string',
|
|
4226
|
-
description: '
|
|
4227
|
-
example: '
|
|
5181
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5182
|
+
example: '2026-07-24'
|
|
4228
5183
|
},
|
|
4229
|
-
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
|
|
5184
|
+
actualBalance: {
|
|
5185
|
+
description: 'Actual balance from the external statement.',
|
|
5186
|
+
allOf: [
|
|
5187
|
+
{
|
|
5188
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5189
|
+
}
|
|
5190
|
+
]
|
|
4233
5191
|
},
|
|
4234
|
-
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
|
|
4239
|
-
|
|
5192
|
+
tolerance: {
|
|
5193
|
+
type: 'string',
|
|
5194
|
+
description:
|
|
5195
|
+
'Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).',
|
|
5196
|
+
example: '0.01'
|
|
5197
|
+
}
|
|
5198
|
+
},
|
|
5199
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5200
|
+
} as const;
|
|
5201
|
+
|
|
5202
|
+
export const $ReconciliationRecordDto = {
|
|
5203
|
+
type: 'object',
|
|
5204
|
+
properties: {
|
|
5205
|
+
id: {
|
|
5206
|
+
type: 'string'
|
|
4240
5207
|
},
|
|
4241
|
-
|
|
4242
|
-
|
|
4243
|
-
type: 'array',
|
|
4244
|
-
items: {
|
|
4245
|
-
type: 'string'
|
|
4246
|
-
}
|
|
5208
|
+
accountId: {
|
|
5209
|
+
type: 'string'
|
|
4247
5210
|
},
|
|
4248
|
-
|
|
4249
|
-
type: 'string'
|
|
4250
|
-
description: 'Data source filter'
|
|
5211
|
+
date: {
|
|
5212
|
+
type: 'string'
|
|
4251
5213
|
},
|
|
4252
|
-
|
|
5214
|
+
amount: {
|
|
4253
5215
|
type: 'string',
|
|
4254
|
-
description: '
|
|
4255
|
-
},
|
|
4256
|
-
'filters.tags': {
|
|
4257
|
-
description: 'Tag filters',
|
|
4258
|
-
type: 'array',
|
|
4259
|
-
items: {
|
|
4260
|
-
type: 'string'
|
|
4261
|
-
}
|
|
5216
|
+
description: 'Asserted (actual) amount.'
|
|
4262
5217
|
},
|
|
4263
|
-
|
|
4264
|
-
type: '
|
|
4265
|
-
description: 'Enable experimental features'
|
|
5218
|
+
currency: {
|
|
5219
|
+
type: 'string'
|
|
4266
5220
|
},
|
|
4267
|
-
|
|
4268
|
-
type: '
|
|
4269
|
-
description: 'Enable restricted view mode'
|
|
5221
|
+
tolerance: {
|
|
5222
|
+
type: 'string'
|
|
4270
5223
|
},
|
|
4271
|
-
|
|
5224
|
+
diffAmount: {
|
|
4272
5225
|
type: 'string',
|
|
4273
|
-
description: '
|
|
4274
|
-
example: 'en'
|
|
5226
|
+
description: 'book − actual.'
|
|
4275
5227
|
},
|
|
4276
|
-
|
|
4277
|
-
type: 'string'
|
|
4278
|
-
description: 'Locale code',
|
|
4279
|
-
example: 'en-US'
|
|
5228
|
+
diffCurrency: {
|
|
5229
|
+
type: 'string'
|
|
4280
5230
|
},
|
|
4281
|
-
|
|
4282
|
-
type: '
|
|
4283
|
-
|
|
4284
|
-
|
|
5231
|
+
createdAt: {
|
|
5232
|
+
type: 'string'
|
|
5233
|
+
}
|
|
5234
|
+
},
|
|
5235
|
+
required: ['id', 'accountId', 'date', 'amount', 'currency', 'createdAt']
|
|
5236
|
+
} as const;
|
|
5237
|
+
|
|
5238
|
+
export const $PadReconciliationDto = {
|
|
5239
|
+
type: 'object',
|
|
5240
|
+
properties: {
|
|
5241
|
+
accountId: {
|
|
5242
|
+
type: 'string',
|
|
5243
|
+
description: 'BeanAccount id to reconcile.'
|
|
4285
5244
|
},
|
|
4286
|
-
|
|
5245
|
+
asOfDate: {
|
|
4287
5246
|
type: 'string',
|
|
4288
|
-
description: '
|
|
4289
|
-
example: '
|
|
5247
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5248
|
+
example: '2026-07-24'
|
|
4290
5249
|
},
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
|
|
4294
|
-
|
|
5250
|
+
actualBalance: {
|
|
5251
|
+
description: 'Actual balance from the external statement.',
|
|
5252
|
+
allOf: [
|
|
5253
|
+
{
|
|
5254
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5255
|
+
}
|
|
5256
|
+
]
|
|
4295
5257
|
},
|
|
4296
|
-
|
|
5258
|
+
sourceAccount: {
|
|
4297
5259
|
type: 'string',
|
|
4298
|
-
description:
|
|
4299
|
-
|
|
5260
|
+
description:
|
|
5261
|
+
'Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).',
|
|
5262
|
+
example: 'Equity:Opening-Balances',
|
|
5263
|
+
default: 'Equity:Opening-Balances'
|
|
4300
5264
|
}
|
|
4301
|
-
}
|
|
5265
|
+
},
|
|
5266
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
4302
5267
|
} as const;
|
|
4303
5268
|
|
|
4304
|
-
export const $
|
|
5269
|
+
export const $PadResultDto = {
|
|
4305
5270
|
type: 'object',
|
|
4306
5271
|
properties: {
|
|
4307
|
-
|
|
5272
|
+
transactionId: {
|
|
4308
5273
|
type: 'string',
|
|
4309
|
-
description: '
|
|
5274
|
+
description: 'Created pad adjusting transaction id.'
|
|
4310
5275
|
}
|
|
4311
5276
|
},
|
|
4312
|
-
required: ['
|
|
5277
|
+
required: ['transactionId']
|
|
4313
5278
|
} as const;
|
|
4314
5279
|
|
|
4315
5280
|
export const $FileImportDto = {
|
|
@@ -4478,7 +5443,7 @@ export const $IdentifyResultDto = {
|
|
|
4478
5443
|
account: {
|
|
4479
5444
|
type: 'string',
|
|
4480
5445
|
description: 'Default account used by this importer',
|
|
4481
|
-
example: 'Assets:Alipay:Balance'
|
|
5446
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4482
5447
|
},
|
|
4483
5448
|
message: {
|
|
4484
5449
|
type: 'string',
|
|
@@ -4495,7 +5460,7 @@ export const $MapperDefaultsDto = {
|
|
|
4495
5460
|
sourceAccount: {
|
|
4496
5461
|
type: 'string',
|
|
4497
5462
|
description: 'Source account for transactions (Beancount format)',
|
|
4498
|
-
example: 'Assets:Alipay:Balance'
|
|
5463
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4499
5464
|
},
|
|
4500
5465
|
currency: {
|
|
4501
5466
|
type: 'string',
|
|
@@ -4532,7 +5497,7 @@ export const $MapperDefaultsDto = {
|
|
|
4532
5497
|
description:
|
|
4533
5498
|
'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
|
|
4534
5499
|
example: {
|
|
4535
|
-
HuaBei: 'Liabilities:
|
|
5500
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4536
5501
|
CreditCard: 'Liabilities:CreditCard'
|
|
4537
5502
|
}
|
|
4538
5503
|
}
|
|
@@ -4664,7 +5629,7 @@ export const $UpdateMapperDefaultsDto = {
|
|
|
4664
5629
|
sourceAccount: {
|
|
4665
5630
|
type: 'string',
|
|
4666
5631
|
description: 'Source account for transactions (Beancount format)',
|
|
4667
|
-
example: 'Assets:Alipay:Balance',
|
|
5632
|
+
example: 'Assets:CN:Alipay:Balance',
|
|
4668
5633
|
pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
|
|
4669
5634
|
},
|
|
4670
5635
|
currency: {
|
|
@@ -4692,7 +5657,7 @@ export const $UpdateMapperDefaultsDto = {
|
|
|
4692
5657
|
description:
|
|
4693
5658
|
'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
|
|
4694
5659
|
example: {
|
|
4695
|
-
HuaBei: 'Liabilities:
|
|
5660
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4696
5661
|
CreditCard: 'Liabilities:CreditCard'
|
|
4697
5662
|
}
|
|
4698
5663
|
}
|
|
@@ -4705,130 +5670,24 @@ export const $UpdateConfigDataDto = {
|
|
|
4705
5670
|
defaults: {
|
|
4706
5671
|
description: 'Mapper defaults configuration',
|
|
4707
5672
|
allOf: [
|
|
4708
|
-
{
|
|
4709
|
-
$ref: '#/components/schemas/UpdateMapperDefaultsDto'
|
|
4710
|
-
}
|
|
4711
|
-
]
|
|
4712
|
-
}
|
|
4713
|
-
}
|
|
4714
|
-
} as const;
|
|
4715
|
-
|
|
4716
|
-
export const $UpdateImporterConfigDto = {
|
|
4717
|
-
type: 'object',
|
|
4718
|
-
properties: {
|
|
4719
|
-
data: {
|
|
4720
|
-
description: 'Configuration data (v1 schema)',
|
|
4721
|
-
allOf: [
|
|
4722
|
-
{
|
|
4723
|
-
$ref: '#/components/schemas/UpdateConfigDataDto'
|
|
4724
|
-
}
|
|
4725
|
-
]
|
|
4726
|
-
}
|
|
4727
|
-
}
|
|
4728
|
-
} as const;
|
|
4729
|
-
|
|
4730
|
-
export const $CreatePlatformDto = {
|
|
4731
|
-
type: 'object',
|
|
4732
|
-
properties: {
|
|
4733
|
-
name: {
|
|
4734
|
-
type: 'string',
|
|
4735
|
-
description: 'Platform name',
|
|
4736
|
-
example: 'Binance'
|
|
4737
|
-
},
|
|
4738
|
-
canonical: {
|
|
4739
|
-
type: 'string',
|
|
4740
|
-
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
4741
|
-
example: 'binance'
|
|
4742
|
-
},
|
|
4743
|
-
aliases: {
|
|
4744
|
-
description: 'Platform aliases (multi-language names for lookup)',
|
|
4745
|
-
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
4746
|
-
type: 'array',
|
|
4747
|
-
items: {
|
|
4748
|
-
type: 'string'
|
|
4749
|
-
}
|
|
4750
|
-
},
|
|
4751
|
-
url: {
|
|
4752
|
-
type: 'string',
|
|
4753
|
-
description: 'Platform URL',
|
|
4754
|
-
example: 'https://www.binance.com'
|
|
4755
|
-
},
|
|
4756
|
-
type: {
|
|
4757
|
-
type: 'string',
|
|
4758
|
-
description: 'Platform type',
|
|
4759
|
-
enum: [
|
|
4760
|
-
'BANK',
|
|
4761
|
-
'BROKERAGE',
|
|
4762
|
-
'CRYPTO_EXCHANGE',
|
|
4763
|
-
'PAYMENT',
|
|
4764
|
-
'INVESTMENT',
|
|
4765
|
-
'INSURANCE',
|
|
4766
|
-
'OTHER'
|
|
4767
|
-
],
|
|
4768
|
-
example: 'CRYPTO_EXCHANGE'
|
|
4769
|
-
},
|
|
4770
|
-
logoUrl: {
|
|
4771
|
-
type: 'string',
|
|
4772
|
-
description: 'Platform logo URL',
|
|
4773
|
-
example: 'https://example.com/logos/binance.png'
|
|
4774
|
-
},
|
|
4775
|
-
isActive: {
|
|
4776
|
-
type: 'boolean',
|
|
4777
|
-
description: 'Whether the platform is active',
|
|
4778
|
-
default: true
|
|
4779
|
-
}
|
|
4780
|
-
},
|
|
4781
|
-
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
4782
|
-
} as const;
|
|
4783
|
-
|
|
4784
|
-
export const $UpdatePlatformDto = {
|
|
4785
|
-
type: 'object',
|
|
4786
|
-
properties: {
|
|
4787
|
-
name: {
|
|
4788
|
-
type: 'string',
|
|
4789
|
-
description: 'Platform name',
|
|
4790
|
-
example: 'Binance'
|
|
4791
|
-
},
|
|
4792
|
-
canonical: {
|
|
4793
|
-
type: 'string',
|
|
4794
|
-
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
4795
|
-
example: 'binance'
|
|
4796
|
-
},
|
|
4797
|
-
aliases: {
|
|
4798
|
-
description: 'Platform aliases (multi-language names for lookup)',
|
|
4799
|
-
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
4800
|
-
type: 'array',
|
|
4801
|
-
items: {
|
|
4802
|
-
type: 'string'
|
|
4803
|
-
}
|
|
4804
|
-
},
|
|
4805
|
-
url: {
|
|
4806
|
-
type: 'string',
|
|
4807
|
-
description: 'Platform URL',
|
|
4808
|
-
example: 'https://www.binance.com'
|
|
4809
|
-
},
|
|
4810
|
-
type: {
|
|
4811
|
-
type: 'string',
|
|
4812
|
-
description: 'Platform type',
|
|
4813
|
-
enum: [
|
|
4814
|
-
'BANK',
|
|
4815
|
-
'BROKERAGE',
|
|
4816
|
-
'CRYPTO_EXCHANGE',
|
|
4817
|
-
'PAYMENT',
|
|
4818
|
-
'INVESTMENT',
|
|
4819
|
-
'INSURANCE',
|
|
4820
|
-
'OTHER'
|
|
4821
|
-
],
|
|
4822
|
-
example: 'CRYPTO_EXCHANGE'
|
|
4823
|
-
},
|
|
4824
|
-
logoUrl: {
|
|
4825
|
-
type: 'string',
|
|
4826
|
-
description: 'Platform logo URL',
|
|
4827
|
-
example: 'https://example.com/logos/binance.png'
|
|
4828
|
-
},
|
|
4829
|
-
isActive: {
|
|
4830
|
-
type: 'boolean',
|
|
4831
|
-
description: 'Whether the platform is active'
|
|
5673
|
+
{
|
|
5674
|
+
$ref: '#/components/schemas/UpdateMapperDefaultsDto'
|
|
5675
|
+
}
|
|
5676
|
+
]
|
|
5677
|
+
}
|
|
5678
|
+
}
|
|
5679
|
+
} as const;
|
|
5680
|
+
|
|
5681
|
+
export const $UpdateImporterConfigDto = {
|
|
5682
|
+
type: 'object',
|
|
5683
|
+
properties: {
|
|
5684
|
+
data: {
|
|
5685
|
+
description: 'Configuration data (v1 schema)',
|
|
5686
|
+
allOf: [
|
|
5687
|
+
{
|
|
5688
|
+
$ref: '#/components/schemas/UpdateConfigDataDto'
|
|
5689
|
+
}
|
|
5690
|
+
]
|
|
4832
5691
|
}
|
|
4833
5692
|
}
|
|
4834
5693
|
} as const;
|
|
@@ -4839,7 +5698,7 @@ export const $ProviderSyncConfigDto = {
|
|
|
4839
5698
|
sourceAccount: {
|
|
4840
5699
|
type: 'string',
|
|
4841
5700
|
description: 'Source account for the first posting',
|
|
4842
|
-
example: 'Assets:
|
|
5701
|
+
example: 'Assets:US:Chase:Checking'
|
|
4843
5702
|
},
|
|
4844
5703
|
defaultCurrency: {
|
|
4845
5704
|
type: 'string',
|
|
@@ -4860,6 +5719,12 @@ export const $ProviderSyncConfigDto = {
|
|
|
4860
5719
|
type: 'boolean',
|
|
4861
5720
|
description: 'Filter pending transactions',
|
|
4862
5721
|
default: true
|
|
5722
|
+
},
|
|
5723
|
+
externalAccountId: {
|
|
5724
|
+
type: 'string',
|
|
5725
|
+
description:
|
|
5726
|
+
'External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.',
|
|
5727
|
+
example: 'acc_gocardless_001'
|
|
4863
5728
|
}
|
|
4864
5729
|
},
|
|
4865
5730
|
required: [
|
|
@@ -4979,6 +5844,94 @@ export const $SupportedProvidersResponseDto = {
|
|
|
4979
5844
|
required: ['providers']
|
|
4980
5845
|
} as const;
|
|
4981
5846
|
|
|
5847
|
+
export const $CreateExternalAccountLinkDto = {
|
|
5848
|
+
type: 'object',
|
|
5849
|
+
properties: {
|
|
5850
|
+
provider: {
|
|
5851
|
+
type: 'string',
|
|
5852
|
+
enum: [
|
|
5853
|
+
'plaid',
|
|
5854
|
+
'teller',
|
|
5855
|
+
'truelayer',
|
|
5856
|
+
'gocardless',
|
|
5857
|
+
'simplefin',
|
|
5858
|
+
'yodlee',
|
|
5859
|
+
'beancount-direct',
|
|
5860
|
+
'parsed-bill'
|
|
5861
|
+
],
|
|
5862
|
+
example: 'plaid',
|
|
5863
|
+
description: 'Open Banking provider (whitelist)'
|
|
5864
|
+
},
|
|
5865
|
+
externalAccountId: {
|
|
5866
|
+
type: 'string',
|
|
5867
|
+
example: 'acc-plaid-001',
|
|
5868
|
+
description: 'External account ID from the provider'
|
|
5869
|
+
},
|
|
5870
|
+
beanAccountId: {
|
|
5871
|
+
type: 'string',
|
|
5872
|
+
example: '550e8400-e29b-41d4-a716-446655440000',
|
|
5873
|
+
description: 'Target BeanAccount ID (must belong to the JWT user)'
|
|
5874
|
+
}
|
|
5875
|
+
},
|
|
5876
|
+
required: ['provider', 'externalAccountId', 'beanAccountId']
|
|
5877
|
+
} as const;
|
|
5878
|
+
|
|
5879
|
+
export const $ExternalAccountLinkResponseDto = {
|
|
5880
|
+
type: 'object',
|
|
5881
|
+
properties: {
|
|
5882
|
+
id: {
|
|
5883
|
+
type: 'string'
|
|
5884
|
+
},
|
|
5885
|
+
provider: {
|
|
5886
|
+
type: 'string'
|
|
5887
|
+
},
|
|
5888
|
+
externalAccountId: {
|
|
5889
|
+
type: 'string'
|
|
5890
|
+
},
|
|
5891
|
+
beanAccountId: {
|
|
5892
|
+
type: 'string'
|
|
5893
|
+
},
|
|
5894
|
+
isActive: {
|
|
5895
|
+
type: 'boolean'
|
|
5896
|
+
},
|
|
5897
|
+
createdAt: {
|
|
5898
|
+
type: 'string'
|
|
5899
|
+
},
|
|
5900
|
+
updatedAt: {
|
|
5901
|
+
type: 'string'
|
|
5902
|
+
}
|
|
5903
|
+
},
|
|
5904
|
+
required: [
|
|
5905
|
+
'id',
|
|
5906
|
+
'provider',
|
|
5907
|
+
'externalAccountId',
|
|
5908
|
+
'beanAccountId',
|
|
5909
|
+
'isActive',
|
|
5910
|
+
'createdAt',
|
|
5911
|
+
'updatedAt'
|
|
5912
|
+
]
|
|
5913
|
+
} as const;
|
|
5914
|
+
|
|
5915
|
+
export const $ExternalAccountLinkListResponseDto = {
|
|
5916
|
+
type: 'object',
|
|
5917
|
+
properties: {
|
|
5918
|
+
items: {
|
|
5919
|
+
type: 'array',
|
|
5920
|
+
items: {
|
|
5921
|
+
$ref: '#/components/schemas/ExternalAccountLinkResponseDto'
|
|
5922
|
+
}
|
|
5923
|
+
},
|
|
5924
|
+
total: {
|
|
5925
|
+
type: 'number'
|
|
5926
|
+
},
|
|
5927
|
+
provider: {
|
|
5928
|
+
type: 'string',
|
|
5929
|
+
description: 'Filter by provider (query param)'
|
|
5930
|
+
}
|
|
5931
|
+
},
|
|
5932
|
+
required: ['items', 'total']
|
|
5933
|
+
} as const;
|
|
5934
|
+
|
|
4982
5935
|
export const $ParserTelemetryReportDto = {
|
|
4983
5936
|
type: 'object',
|
|
4984
5937
|
properties: {}
|
|
@@ -5013,6 +5966,18 @@ export const $ProcessNlpDto = {
|
|
|
5013
5966
|
currency: 'CNY',
|
|
5014
5967
|
payee: 'Starbucks'
|
|
5015
5968
|
}
|
|
5969
|
+
},
|
|
5970
|
+
selectedRuleId: {
|
|
5971
|
+
type: 'string',
|
|
5972
|
+
description:
|
|
5973
|
+
'confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.',
|
|
5974
|
+
example: 'rule_abc123'
|
|
5975
|
+
},
|
|
5976
|
+
selectedAccount: {
|
|
5977
|
+
type: 'string',
|
|
5978
|
+
description:
|
|
5979
|
+
'confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i], or a typed path). Applied directly when the session is confirming_account — no NL re-parse.',
|
|
5980
|
+
example: 'Expenses:Food:Coffee'
|
|
5016
5981
|
}
|
|
5017
5982
|
},
|
|
5018
5983
|
required: ['message']
|
|
@@ -5337,7 +6302,8 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5337
6302
|
},
|
|
5338
6303
|
suggestedAccount: {
|
|
5339
6304
|
type: 'string',
|
|
5340
|
-
description:
|
|
6305
|
+
description:
|
|
6306
|
+
'Suggested replacement account (omitted when no clear candidate)',
|
|
5341
6307
|
example: 'Expenses:Food:Drinks'
|
|
5342
6308
|
},
|
|
5343
6309
|
similarAccounts: {
|
|
@@ -5359,7 +6325,6 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5359
6325
|
},
|
|
5360
6326
|
required: [
|
|
5361
6327
|
'invalidAccount',
|
|
5362
|
-
'suggestedAccount',
|
|
5363
6328
|
'similarAccounts',
|
|
5364
6329
|
'errorMessage',
|
|
5365
6330
|
'transactionContext'
|
|
@@ -5528,7 +6493,7 @@ export const $NlpSuggestedAccountDto = {
|
|
|
5528
6493
|
account: {
|
|
5529
6494
|
type: 'string',
|
|
5530
6495
|
description: 'Suggested account path',
|
|
5531
|
-
example: 'Assets:
|
|
6496
|
+
example: 'Assets:Checking'
|
|
5532
6497
|
},
|
|
5533
6498
|
confidence: {
|
|
5534
6499
|
type: 'number',
|
|
@@ -5569,7 +6534,7 @@ export const $NlpDefaultAccountsDto = {
|
|
|
5569
6534
|
asset: {
|
|
5570
6535
|
type: 'string',
|
|
5571
6536
|
description: 'Default asset account',
|
|
5572
|
-
example: 'Assets:
|
|
6537
|
+
example: 'Assets:Checking'
|
|
5573
6538
|
},
|
|
5574
6539
|
expense: {
|
|
5575
6540
|
type: 'string',
|
|
@@ -5609,7 +6574,8 @@ export const $NlpResponseDto = {
|
|
|
5609
6574
|
'confirm_rule',
|
|
5610
6575
|
'confirm_account',
|
|
5611
6576
|
'confirm_payee',
|
|
5612
|
-
'cancel'
|
|
6577
|
+
'cancel',
|
|
6578
|
+
'aborted'
|
|
5613
6579
|
]
|
|
5614
6580
|
},
|
|
5615
6581
|
intent: {
|
|
@@ -5788,24 +6754,255 @@ export const $NlpResponseDto = {
|
|
|
5788
6754
|
]
|
|
5789
6755
|
}
|
|
5790
6756
|
},
|
|
5791
|
-
required: ['status', 'action']
|
|
6757
|
+
required: ['status', 'action']
|
|
6758
|
+
} as const;
|
|
6759
|
+
|
|
6760
|
+
export const $PlatformListItemDto = {
|
|
6761
|
+
type: 'object',
|
|
6762
|
+
properties: {
|
|
6763
|
+
id: {
|
|
6764
|
+
type: 'string',
|
|
6765
|
+
description: 'Global platform ID'
|
|
6766
|
+
},
|
|
6767
|
+
name: {
|
|
6768
|
+
type: 'string',
|
|
6769
|
+
description: 'Platform name'
|
|
6770
|
+
},
|
|
6771
|
+
url: {
|
|
6772
|
+
type: 'string',
|
|
6773
|
+
description: 'Platform URL'
|
|
6774
|
+
},
|
|
6775
|
+
type: {
|
|
6776
|
+
type: 'string',
|
|
6777
|
+
description: 'Platform type',
|
|
6778
|
+
enum: [
|
|
6779
|
+
'BANK',
|
|
6780
|
+
'BROKERAGE',
|
|
6781
|
+
'CRYPTO_EXCHANGE',
|
|
6782
|
+
'PAYMENT',
|
|
6783
|
+
'INVESTMENT',
|
|
6784
|
+
'INSURANCE',
|
|
6785
|
+
'OTHER'
|
|
6786
|
+
]
|
|
6787
|
+
},
|
|
6788
|
+
canonical: {
|
|
6789
|
+
type: 'string',
|
|
6790
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
6791
|
+
},
|
|
6792
|
+
suggestedSegment: {
|
|
6793
|
+
type: 'string',
|
|
6794
|
+
description:
|
|
6795
|
+
'Suggested path segment — canonical with first char uppercased (ACC_COMP_NAME_RE)'
|
|
6796
|
+
},
|
|
6797
|
+
logoUrl: {
|
|
6798
|
+
type: 'string',
|
|
6799
|
+
description: 'Logo URL',
|
|
6800
|
+
nullable: true
|
|
6801
|
+
},
|
|
6802
|
+
isBound: {
|
|
6803
|
+
type: 'boolean',
|
|
6804
|
+
description: 'Whether user has accounts using this platform'
|
|
6805
|
+
}
|
|
6806
|
+
},
|
|
6807
|
+
required: [
|
|
6808
|
+
'id',
|
|
6809
|
+
'name',
|
|
6810
|
+
'url',
|
|
6811
|
+
'type',
|
|
6812
|
+
'canonical',
|
|
6813
|
+
'suggestedSegment',
|
|
6814
|
+
'logoUrl',
|
|
6815
|
+
'isBound'
|
|
6816
|
+
]
|
|
6817
|
+
} as const;
|
|
6818
|
+
|
|
6819
|
+
export const $PlatformMatchResultDto = {
|
|
6820
|
+
type: 'object',
|
|
6821
|
+
properties: {
|
|
6822
|
+
id: {
|
|
6823
|
+
type: 'string',
|
|
6824
|
+
description: 'Global platform ID'
|
|
6825
|
+
},
|
|
6826
|
+
name: {
|
|
6827
|
+
type: 'string',
|
|
6828
|
+
description: 'Platform name (e.g., "ICBC")'
|
|
6829
|
+
},
|
|
6830
|
+
canonical: {
|
|
6831
|
+
type: 'string',
|
|
6832
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
6833
|
+
},
|
|
6834
|
+
type: {
|
|
6835
|
+
type: 'string',
|
|
6836
|
+
description: 'Platform type',
|
|
6837
|
+
enum: [
|
|
6838
|
+
'BANK',
|
|
6839
|
+
'BROKERAGE',
|
|
6840
|
+
'CRYPTO_EXCHANGE',
|
|
6841
|
+
'PAYMENT',
|
|
6842
|
+
'INVESTMENT',
|
|
6843
|
+
'INSURANCE',
|
|
6844
|
+
'OTHER'
|
|
6845
|
+
]
|
|
6846
|
+
},
|
|
6847
|
+
suggestedSegment: {
|
|
6848
|
+
type: 'string',
|
|
6849
|
+
description:
|
|
6850
|
+
'Suggested path segment — canonical, already in ACCOUNT_RE format'
|
|
6851
|
+
},
|
|
6852
|
+
logoUrl: {
|
|
6853
|
+
type: 'string',
|
|
6854
|
+
description: 'Logo URL',
|
|
6855
|
+
nullable: true
|
|
6856
|
+
},
|
|
6857
|
+
matchType: {
|
|
6858
|
+
type: 'string',
|
|
6859
|
+
description: "How this row matched: 'exact' > 'prefix' > 'substring'",
|
|
6860
|
+
enum: ['exact', 'prefix', 'substring']
|
|
6861
|
+
}
|
|
6862
|
+
},
|
|
6863
|
+
required: [
|
|
6864
|
+
'id',
|
|
6865
|
+
'name',
|
|
6866
|
+
'canonical',
|
|
6867
|
+
'type',
|
|
6868
|
+
'suggestedSegment',
|
|
6869
|
+
'logoUrl',
|
|
6870
|
+
'matchType'
|
|
6871
|
+
]
|
|
6872
|
+
} as const;
|
|
6873
|
+
|
|
6874
|
+
export const $PlatformMatchResponseDto = {
|
|
6875
|
+
type: 'object',
|
|
6876
|
+
properties: {
|
|
6877
|
+
platforms: {
|
|
6878
|
+
description: 'Ranked matches, best tier first (at most 10 rows)',
|
|
6879
|
+
type: 'array',
|
|
6880
|
+
items: {
|
|
6881
|
+
$ref: '#/components/schemas/PlatformMatchResultDto'
|
|
6882
|
+
}
|
|
6883
|
+
},
|
|
6884
|
+
matchType: {
|
|
6885
|
+
type: 'string',
|
|
6886
|
+
description:
|
|
6887
|
+
"Overall match quality — top row's tier, or 'none' when no hits",
|
|
6888
|
+
enum: ['none', 'exact', 'prefix', 'substring']
|
|
6889
|
+
},
|
|
6890
|
+
total: {
|
|
6891
|
+
type: 'number',
|
|
6892
|
+
description: 'Total matches before LIMIT (truncation transparency)'
|
|
6893
|
+
},
|
|
6894
|
+
hasMore: {
|
|
6895
|
+
type: 'boolean',
|
|
6896
|
+
description: 'true when total > platforms.length (more matches exist)'
|
|
6897
|
+
}
|
|
6898
|
+
},
|
|
6899
|
+
required: ['platforms', 'matchType', 'total', 'hasMore']
|
|
6900
|
+
} as const;
|
|
6901
|
+
|
|
6902
|
+
export const $CreatePlatformDto = {
|
|
6903
|
+
type: 'object',
|
|
6904
|
+
properties: {
|
|
6905
|
+
name: {
|
|
6906
|
+
type: 'string',
|
|
6907
|
+
description: 'Platform name',
|
|
6908
|
+
example: 'Binance'
|
|
6909
|
+
},
|
|
6910
|
+
canonical: {
|
|
6911
|
+
type: 'string',
|
|
6912
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
6913
|
+
example: 'binance'
|
|
6914
|
+
},
|
|
6915
|
+
aliases: {
|
|
6916
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
6917
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
6918
|
+
type: 'array',
|
|
6919
|
+
items: {
|
|
6920
|
+
type: 'string'
|
|
6921
|
+
}
|
|
6922
|
+
},
|
|
6923
|
+
url: {
|
|
6924
|
+
type: 'string',
|
|
6925
|
+
description: 'Platform URL',
|
|
6926
|
+
example: 'https://www.binance.com'
|
|
6927
|
+
},
|
|
6928
|
+
type: {
|
|
6929
|
+
type: 'string',
|
|
6930
|
+
description: 'Platform type',
|
|
6931
|
+
enum: [
|
|
6932
|
+
'BANK',
|
|
6933
|
+
'BROKERAGE',
|
|
6934
|
+
'CRYPTO_EXCHANGE',
|
|
6935
|
+
'PAYMENT',
|
|
6936
|
+
'INVESTMENT',
|
|
6937
|
+
'INSURANCE',
|
|
6938
|
+
'OTHER'
|
|
6939
|
+
],
|
|
6940
|
+
example: 'CRYPTO_EXCHANGE'
|
|
6941
|
+
},
|
|
6942
|
+
logoUrl: {
|
|
6943
|
+
type: 'string',
|
|
6944
|
+
description: 'Platform logo URL',
|
|
6945
|
+
example: 'https://example.com/logos/binance.png'
|
|
6946
|
+
},
|
|
6947
|
+
isActive: {
|
|
6948
|
+
type: 'boolean',
|
|
6949
|
+
description: 'Whether the platform is active',
|
|
6950
|
+
default: true
|
|
6951
|
+
}
|
|
6952
|
+
},
|
|
6953
|
+
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
5792
6954
|
} as const;
|
|
5793
6955
|
|
|
5794
|
-
export const $
|
|
6956
|
+
export const $UpdatePlatformDto = {
|
|
5795
6957
|
type: 'object',
|
|
5796
6958
|
properties: {
|
|
5797
|
-
|
|
6959
|
+
name: {
|
|
5798
6960
|
type: 'string',
|
|
5799
|
-
description: '
|
|
5800
|
-
example: '
|
|
6961
|
+
description: 'Platform name',
|
|
6962
|
+
example: 'Binance'
|
|
5801
6963
|
},
|
|
5802
|
-
|
|
6964
|
+
canonical: {
|
|
5803
6965
|
type: 'string',
|
|
5804
|
-
description: '
|
|
5805
|
-
example: '
|
|
6966
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
6967
|
+
example: 'binance'
|
|
6968
|
+
},
|
|
6969
|
+
aliases: {
|
|
6970
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
6971
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
6972
|
+
type: 'array',
|
|
6973
|
+
items: {
|
|
6974
|
+
type: 'string'
|
|
6975
|
+
}
|
|
6976
|
+
},
|
|
6977
|
+
url: {
|
|
6978
|
+
type: 'string',
|
|
6979
|
+
description: 'Platform URL',
|
|
6980
|
+
example: 'https://www.binance.com'
|
|
6981
|
+
},
|
|
6982
|
+
type: {
|
|
6983
|
+
type: 'string',
|
|
6984
|
+
description: 'Platform type',
|
|
6985
|
+
enum: [
|
|
6986
|
+
'BANK',
|
|
6987
|
+
'BROKERAGE',
|
|
6988
|
+
'CRYPTO_EXCHANGE',
|
|
6989
|
+
'PAYMENT',
|
|
6990
|
+
'INVESTMENT',
|
|
6991
|
+
'INSURANCE',
|
|
6992
|
+
'OTHER'
|
|
6993
|
+
],
|
|
6994
|
+
example: 'CRYPTO_EXCHANGE'
|
|
6995
|
+
},
|
|
6996
|
+
logoUrl: {
|
|
6997
|
+
type: 'string',
|
|
6998
|
+
description: 'Platform logo URL',
|
|
6999
|
+
example: 'https://example.com/logos/binance.png'
|
|
7000
|
+
},
|
|
7001
|
+
isActive: {
|
|
7002
|
+
type: 'boolean',
|
|
7003
|
+
description: 'Whether the platform is active'
|
|
5806
7004
|
}
|
|
5807
|
-
}
|
|
5808
|
-
required: ['currency', 'balance']
|
|
7005
|
+
}
|
|
5809
7006
|
} as const;
|
|
5810
7007
|
|
|
5811
7008
|
export const $NetWorthByCurrencyDto = {
|
|
@@ -5877,28 +7074,6 @@ export const $ConvertedNetWorthDto = {
|
|
|
5877
7074
|
]
|
|
5878
7075
|
} as const;
|
|
5879
7076
|
|
|
5880
|
-
export const $ExchangeRateWarningDto = {
|
|
5881
|
-
type: 'object',
|
|
5882
|
-
properties: {
|
|
5883
|
-
type: {
|
|
5884
|
-
type: 'string',
|
|
5885
|
-
description: 'Warning type',
|
|
5886
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
5887
|
-
},
|
|
5888
|
-
currency: {
|
|
5889
|
-
type: 'string',
|
|
5890
|
-
description: 'Currency without exchange rate',
|
|
5891
|
-
example: 'EUR'
|
|
5892
|
-
},
|
|
5893
|
-
totalAmount: {
|
|
5894
|
-
type: 'string',
|
|
5895
|
-
description: 'Total amount affected',
|
|
5896
|
-
example: '1000.00'
|
|
5897
|
-
}
|
|
5898
|
-
},
|
|
5899
|
-
required: ['type', 'currency', 'totalAmount']
|
|
5900
|
-
} as const;
|
|
5901
|
-
|
|
5902
7077
|
export const $NetWorthResponseDto = {
|
|
5903
7078
|
type: 'object',
|
|
5904
7079
|
properties: {
|
|
@@ -5984,7 +7159,7 @@ export const $AccountItemDto = {
|
|
|
5984
7159
|
name: {
|
|
5985
7160
|
type: 'string',
|
|
5986
7161
|
description: 'Full account name',
|
|
5987
|
-
example: 'Assets:
|
|
7162
|
+
example: 'Assets:CN:CMB:Savings'
|
|
5988
7163
|
},
|
|
5989
7164
|
displayName: {
|
|
5990
7165
|
type: 'string',
|
|
@@ -6000,6 +7175,12 @@ export const $AccountItemDto = {
|
|
|
6000
7175
|
type: 'string',
|
|
6001
7176
|
description: 'Currency code',
|
|
6002
7177
|
example: 'CNY'
|
|
7178
|
+
},
|
|
7179
|
+
convertedBalance: {
|
|
7180
|
+
type: 'string',
|
|
7181
|
+
description:
|
|
7182
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7183
|
+
example: '50000.00'
|
|
6003
7184
|
}
|
|
6004
7185
|
},
|
|
6005
7186
|
required: ['id', 'name', 'displayName', 'balance', 'currency']
|
|
@@ -6026,11 +7207,66 @@ export const $PlatformGroupDto = {
|
|
|
6026
7207
|
},
|
|
6027
7208
|
totalBalance: {
|
|
6028
7209
|
type: 'string',
|
|
6029
|
-
description: '
|
|
7210
|
+
description: 'FX-converted total balance in base currency',
|
|
7211
|
+
example: '100000.00'
|
|
7212
|
+
},
|
|
7213
|
+
balanceByCurrency: {
|
|
7214
|
+
description: 'Raw (unconverted) balances grouped by currency',
|
|
7215
|
+
type: 'array',
|
|
7216
|
+
items: {
|
|
7217
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7218
|
+
}
|
|
7219
|
+
},
|
|
7220
|
+
convertedBalance: {
|
|
7221
|
+
type: 'string',
|
|
7222
|
+
description:
|
|
7223
|
+
'Converted balance in base currency (omitted when no currency is convertible)',
|
|
6030
7224
|
example: '100000.00'
|
|
7225
|
+
},
|
|
7226
|
+
sharePct: {
|
|
7227
|
+
type: 'number',
|
|
7228
|
+
description:
|
|
7229
|
+
'Share of the grand converted total (0-100); 0 when grand total is 0',
|
|
7230
|
+
example: 42.5
|
|
7231
|
+
}
|
|
7232
|
+
},
|
|
7233
|
+
required: [
|
|
7234
|
+
'platformId',
|
|
7235
|
+
'platformName',
|
|
7236
|
+
'accounts',
|
|
7237
|
+
'totalBalance',
|
|
7238
|
+
'balanceByCurrency',
|
|
7239
|
+
'sharePct'
|
|
7240
|
+
]
|
|
7241
|
+
} as const;
|
|
7242
|
+
|
|
7243
|
+
export const $AccountExchangeRateWarningDto = {
|
|
7244
|
+
type: 'object',
|
|
7245
|
+
properties: {
|
|
7246
|
+
type: {
|
|
7247
|
+
type: 'string',
|
|
7248
|
+
description: 'Warning type',
|
|
7249
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
7250
|
+
},
|
|
7251
|
+
currency: {
|
|
7252
|
+
type: 'string',
|
|
7253
|
+
description: 'Currency without exchange rate',
|
|
7254
|
+
example: 'USD'
|
|
7255
|
+
},
|
|
7256
|
+
accounts: {
|
|
7257
|
+
description: 'Affected account paths',
|
|
7258
|
+
type: 'array',
|
|
7259
|
+
items: {
|
|
7260
|
+
type: 'string'
|
|
7261
|
+
}
|
|
7262
|
+
},
|
|
7263
|
+
totalAmount: {
|
|
7264
|
+
type: 'string',
|
|
7265
|
+
description: 'Total amount in this currency',
|
|
7266
|
+
example: '5000.00'
|
|
6031
7267
|
}
|
|
6032
7268
|
},
|
|
6033
|
-
required: ['
|
|
7269
|
+
required: ['type', 'currency', 'accounts', 'totalAmount']
|
|
6034
7270
|
} as const;
|
|
6035
7271
|
|
|
6036
7272
|
export const $AccountsSummaryDto = {
|
|
@@ -6043,9 +7279,21 @@ export const $AccountsSummaryDto = {
|
|
|
6043
7279
|
totalPlatforms: {
|
|
6044
7280
|
type: 'number',
|
|
6045
7281
|
description: 'Total number of platforms'
|
|
7282
|
+
},
|
|
7283
|
+
baseCurrency: {
|
|
7284
|
+
type: 'string',
|
|
7285
|
+
description: 'Base currency for conversion',
|
|
7286
|
+
example: 'CNY'
|
|
7287
|
+
},
|
|
7288
|
+
warnings: {
|
|
7289
|
+
description: 'Per-account exchange rate warnings',
|
|
7290
|
+
type: 'array',
|
|
7291
|
+
items: {
|
|
7292
|
+
$ref: '#/components/schemas/AccountExchangeRateWarningDto'
|
|
7293
|
+
}
|
|
6046
7294
|
}
|
|
6047
7295
|
},
|
|
6048
|
-
required: ['totalAccounts', 'totalPlatforms']
|
|
7296
|
+
required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
|
|
6049
7297
|
} as const;
|
|
6050
7298
|
|
|
6051
7299
|
export const $AccountsResponseDto = {
|
|
@@ -6080,7 +7328,7 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
6080
7328
|
name: {
|
|
6081
7329
|
type: 'string',
|
|
6082
7330
|
description: 'Full account name',
|
|
6083
|
-
example: 'Assets:
|
|
7331
|
+
example: 'Assets:CN:CMB:Savings'
|
|
6084
7332
|
},
|
|
6085
7333
|
displayName: {
|
|
6086
7334
|
type: 'string',
|
|
@@ -6097,6 +7345,12 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
6097
7345
|
description: 'Currency code',
|
|
6098
7346
|
example: 'CNY'
|
|
6099
7347
|
},
|
|
7348
|
+
convertedBalance: {
|
|
7349
|
+
type: 'string',
|
|
7350
|
+
description:
|
|
7351
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7352
|
+
example: '50000.00'
|
|
7353
|
+
},
|
|
6100
7354
|
assetClass: {
|
|
6101
7355
|
type: 'string',
|
|
6102
7356
|
description: 'Asset class',
|
|
@@ -6176,35 +7430,6 @@ export const $AssetClassGroupDto = {
|
|
|
6176
7430
|
required: ['assetClass', 'accounts', 'balanceByCurrency']
|
|
6177
7431
|
} as const;
|
|
6178
7432
|
|
|
6179
|
-
export const $AccountExchangeRateWarningDto = {
|
|
6180
|
-
type: 'object',
|
|
6181
|
-
properties: {
|
|
6182
|
-
type: {
|
|
6183
|
-
type: 'string',
|
|
6184
|
-
description: 'Warning type',
|
|
6185
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
6186
|
-
},
|
|
6187
|
-
currency: {
|
|
6188
|
-
type: 'string',
|
|
6189
|
-
description: 'Currency without exchange rate',
|
|
6190
|
-
example: 'USD'
|
|
6191
|
-
},
|
|
6192
|
-
accounts: {
|
|
6193
|
-
description: 'Affected account paths',
|
|
6194
|
-
type: 'array',
|
|
6195
|
-
items: {
|
|
6196
|
-
type: 'string'
|
|
6197
|
-
}
|
|
6198
|
-
},
|
|
6199
|
-
totalAmount: {
|
|
6200
|
-
type: 'string',
|
|
6201
|
-
description: 'Total amount in this currency',
|
|
6202
|
-
example: '5000.00'
|
|
6203
|
-
}
|
|
6204
|
-
},
|
|
6205
|
-
required: ['type', 'currency', 'accounts', 'totalAmount']
|
|
6206
|
-
} as const;
|
|
6207
|
-
|
|
6208
7433
|
export const $AssetClassSummaryDto = {
|
|
6209
7434
|
type: 'object',
|
|
6210
7435
|
properties: {
|
|
@@ -6278,7 +7503,7 @@ export const $HoldingAssetClassAccountSliceDto = {
|
|
|
6278
7503
|
accountPath: {
|
|
6279
7504
|
type: 'string',
|
|
6280
7505
|
description: 'Full account path',
|
|
6281
|
-
example: 'Assets:US:
|
|
7506
|
+
example: 'Assets:US:Fidelity:Brokerage'
|
|
6282
7507
|
},
|
|
6283
7508
|
accountCurrency: {
|
|
6284
7509
|
type: 'string',
|
|
@@ -6450,38 +7675,133 @@ export const $CashFlowResponseDto = {
|
|
|
6450
7675
|
description: 'Base currency code',
|
|
6451
7676
|
example: 'CNY'
|
|
6452
7677
|
},
|
|
6453
|
-
byCurrency: {
|
|
6454
|
-
description: 'Cash flow grouped by original currency',
|
|
6455
|
-
allOf: [
|
|
6456
|
-
{
|
|
6457
|
-
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
6458
|
-
}
|
|
6459
|
-
]
|
|
7678
|
+
byCurrency: {
|
|
7679
|
+
description: 'Cash flow grouped by original currency',
|
|
7680
|
+
allOf: [
|
|
7681
|
+
{
|
|
7682
|
+
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
7683
|
+
}
|
|
7684
|
+
]
|
|
7685
|
+
},
|
|
7686
|
+
converted: {
|
|
7687
|
+
description: 'Converted values in base currency',
|
|
7688
|
+
allOf: [
|
|
7689
|
+
{
|
|
7690
|
+
$ref: '#/components/schemas/ConvertedCashFlowDto'
|
|
7691
|
+
}
|
|
7692
|
+
]
|
|
7693
|
+
},
|
|
7694
|
+
warnings: {
|
|
7695
|
+
description: 'Exchange rate warnings',
|
|
7696
|
+
type: 'array',
|
|
7697
|
+
items: {
|
|
7698
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
7699
|
+
}
|
|
7700
|
+
}
|
|
7701
|
+
},
|
|
7702
|
+
required: [
|
|
7703
|
+
'period',
|
|
7704
|
+
'income',
|
|
7705
|
+
'expense',
|
|
7706
|
+
'netSavings',
|
|
7707
|
+
'savingsRate',
|
|
7708
|
+
'currency'
|
|
7709
|
+
]
|
|
7710
|
+
} as const;
|
|
7711
|
+
|
|
7712
|
+
export const $CategoryGroupDto = {
|
|
7713
|
+
type: 'object',
|
|
7714
|
+
properties: {
|
|
7715
|
+
category: {
|
|
7716
|
+
type: 'string',
|
|
7717
|
+
description:
|
|
7718
|
+
'Functional category (account-path Group segment); regional and universal account paths merge under it',
|
|
7719
|
+
example: 'Food'
|
|
7720
|
+
},
|
|
7721
|
+
totalExpense: {
|
|
7722
|
+
type: 'string',
|
|
7723
|
+
description:
|
|
7724
|
+
'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
|
|
7725
|
+
example: '1200.00'
|
|
7726
|
+
},
|
|
7727
|
+
sharePct: {
|
|
7728
|
+
type: 'number',
|
|
7729
|
+
description: 'Share of grand total (0-100); 0 when grand total is 0',
|
|
7730
|
+
example: 42.5
|
|
7731
|
+
},
|
|
7732
|
+
balanceByCurrency: {
|
|
7733
|
+
description: 'Raw (unconverted) expense per currency',
|
|
7734
|
+
type: 'array',
|
|
7735
|
+
items: {
|
|
7736
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7737
|
+
}
|
|
7738
|
+
},
|
|
7739
|
+
convertedBalance: {
|
|
7740
|
+
type: 'string',
|
|
7741
|
+
description:
|
|
7742
|
+
'Converted total in base currency (omitted when FX missing for all currencies in this category)',
|
|
7743
|
+
example: '1200.00'
|
|
7744
|
+
}
|
|
7745
|
+
},
|
|
7746
|
+
required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
|
|
7747
|
+
} as const;
|
|
7748
|
+
|
|
7749
|
+
export const $ExpensesByCategorySummaryDto = {
|
|
7750
|
+
type: 'object',
|
|
7751
|
+
properties: {
|
|
7752
|
+
totalExpense: {
|
|
7753
|
+
type: 'string',
|
|
7754
|
+
description:
|
|
7755
|
+
'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
|
|
7756
|
+
example: '5000.00'
|
|
7757
|
+
},
|
|
7758
|
+
categoryCount: {
|
|
7759
|
+
type: 'number',
|
|
7760
|
+
description: 'Number of categories',
|
|
7761
|
+
example: 8
|
|
7762
|
+
}
|
|
7763
|
+
},
|
|
7764
|
+
required: ['totalExpense', 'categoryCount']
|
|
7765
|
+
} as const;
|
|
7766
|
+
|
|
7767
|
+
export const $ExpensesByCategoryResponseDto = {
|
|
7768
|
+
type: 'object',
|
|
7769
|
+
properties: {
|
|
7770
|
+
period: {
|
|
7771
|
+
type: 'string',
|
|
7772
|
+
description: 'Period requested',
|
|
7773
|
+
example: '1m'
|
|
7774
|
+
},
|
|
7775
|
+
baseCurrency: {
|
|
7776
|
+
type: 'string',
|
|
7777
|
+
description: 'Base currency for converted values',
|
|
7778
|
+
example: 'CNY'
|
|
7779
|
+
},
|
|
7780
|
+
groups: {
|
|
7781
|
+
description:
|
|
7782
|
+
'Expense groups by functional category, sorted by converted total desc',
|
|
7783
|
+
type: 'array',
|
|
7784
|
+
items: {
|
|
7785
|
+
$ref: '#/components/schemas/CategoryGroupDto'
|
|
7786
|
+
}
|
|
6460
7787
|
},
|
|
6461
|
-
|
|
6462
|
-
description: '
|
|
7788
|
+
summary: {
|
|
7789
|
+
description: 'Summary statistics',
|
|
6463
7790
|
allOf: [
|
|
6464
7791
|
{
|
|
6465
|
-
$ref: '#/components/schemas/
|
|
7792
|
+
$ref: '#/components/schemas/ExpensesByCategorySummaryDto'
|
|
6466
7793
|
}
|
|
6467
7794
|
]
|
|
6468
7795
|
},
|
|
6469
7796
|
warnings: {
|
|
6470
|
-
description: 'Exchange rate warnings',
|
|
7797
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
6471
7798
|
type: 'array',
|
|
6472
7799
|
items: {
|
|
6473
7800
|
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
6474
7801
|
}
|
|
6475
7802
|
}
|
|
6476
7803
|
},
|
|
6477
|
-
required: [
|
|
6478
|
-
'period',
|
|
6479
|
-
'income',
|
|
6480
|
-
'expense',
|
|
6481
|
-
'netSavings',
|
|
6482
|
-
'savingsRate',
|
|
6483
|
-
'currency'
|
|
6484
|
-
]
|
|
7804
|
+
required: ['period', 'baseCurrency', 'groups', 'summary']
|
|
6485
7805
|
} as const;
|
|
6486
7806
|
|
|
6487
7807
|
export const $MonetaryDto = {
|
|
@@ -6698,409 +8018,243 @@ export const $HoldingPnlRowDto = {
|
|
|
6698
8018
|
},
|
|
6699
8019
|
required: [
|
|
6700
8020
|
'accountId',
|
|
6701
|
-
'accountPath',
|
|
6702
|
-
'symbol',
|
|
6703
|
-
'chartToken',
|
|
6704
|
-
'assetClass',
|
|
6705
|
-
'units'
|
|
6706
|
-
]
|
|
6707
|
-
} as const;
|
|
6708
|
-
|
|
6709
|
-
export const $HoldingPnlWarningDto = {
|
|
6710
|
-
type: 'object',
|
|
6711
|
-
properties: {
|
|
6712
|
-
type: {
|
|
6713
|
-
type: 'string',
|
|
6714
|
-
description: 'Warning type',
|
|
6715
|
-
example: 'MISSING_COST_FX_RATE',
|
|
6716
|
-
enum: [
|
|
6717
|
-
'MISSING_COST_FX_RATE',
|
|
6718
|
-
'MISSING_MARKET_FX_RATE',
|
|
6719
|
-
'MISSING_SALE_PRICE',
|
|
6720
|
-
'MISSING_REALIZED_FX_RATE',
|
|
6721
|
-
'OVERSOLD_LOTS',
|
|
6722
|
-
'NO_PRICE',
|
|
6723
|
-
'MIXED_COST_CURRENCY'
|
|
6724
|
-
]
|
|
6725
|
-
},
|
|
6726
|
-
symbol: {
|
|
6727
|
-
type: 'object',
|
|
6728
|
-
nullable: true
|
|
6729
|
-
},
|
|
6730
|
-
accountId: {
|
|
6731
|
-
type: 'object',
|
|
6732
|
-
nullable: true
|
|
6733
|
-
},
|
|
6734
|
-
currency: {
|
|
6735
|
-
type: 'object',
|
|
6736
|
-
nullable: true
|
|
6737
|
-
}
|
|
6738
|
-
},
|
|
6739
|
-
required: ['type']
|
|
6740
|
-
} as const;
|
|
6741
|
-
|
|
6742
|
-
export const $HoldingPnlResponseDto = {
|
|
6743
|
-
type: 'object',
|
|
6744
|
-
properties: {
|
|
6745
|
-
asOfDate: {
|
|
6746
|
-
type: 'string',
|
|
6747
|
-
example: '2026-07-08'
|
|
6748
|
-
},
|
|
6749
|
-
baseCurrency: {
|
|
6750
|
-
type: 'string',
|
|
6751
|
-
example: 'CNY'
|
|
6752
|
-
},
|
|
6753
|
-
method: {
|
|
6754
|
-
type: 'string',
|
|
6755
|
-
description:
|
|
6756
|
-
'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
|
|
6757
|
-
enum: ['average', 'FIFO'],
|
|
6758
|
-
example: 'average'
|
|
6759
|
-
},
|
|
6760
|
-
rows: {
|
|
6761
|
-
type: 'array',
|
|
6762
|
-
items: {
|
|
6763
|
-
$ref: '#/components/schemas/HoldingPnlRowDto'
|
|
6764
|
-
}
|
|
6765
|
-
},
|
|
6766
|
-
warnings: {
|
|
6767
|
-
type: 'array',
|
|
6768
|
-
items: {
|
|
6769
|
-
$ref: '#/components/schemas/HoldingPnlWarningDto'
|
|
6770
|
-
}
|
|
6771
|
-
}
|
|
6772
|
-
},
|
|
6773
|
-
required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
|
|
6774
|
-
} as const;
|
|
6775
|
-
|
|
6776
|
-
export const $CreateBeanPriceDto = {
|
|
6777
|
-
type: 'object',
|
|
6778
|
-
properties: {
|
|
6779
|
-
currency: {
|
|
6780
|
-
type: 'string',
|
|
6781
|
-
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
6782
|
-
example: 'USD'
|
|
6783
|
-
},
|
|
6784
|
-
quoteCurrency: {
|
|
6785
|
-
type: 'string',
|
|
6786
|
-
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
6787
|
-
example: 'CNY'
|
|
6788
|
-
},
|
|
6789
|
-
amount: {
|
|
6790
|
-
type: 'number',
|
|
6791
|
-
description:
|
|
6792
|
-
'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
|
|
6793
|
-
example: 175.5,
|
|
6794
|
-
minimum: 0
|
|
6795
|
-
},
|
|
6796
|
-
date: {
|
|
6797
|
-
type: 'string',
|
|
6798
|
-
description: 'Price date (ISO 8601 format)',
|
|
6799
|
-
example: '2024-11-05'
|
|
6800
|
-
},
|
|
6801
|
-
metadata: {
|
|
6802
|
-
type: 'object',
|
|
6803
|
-
description:
|
|
6804
|
-
'Metadata (validated by Zod schema, max field lengths enforced)',
|
|
6805
|
-
example: {
|
|
6806
|
-
source: 'MANUAL',
|
|
6807
|
-
note: 'Bank valuation report',
|
|
6808
|
-
confidence: 0.95
|
|
6809
|
-
}
|
|
6810
|
-
}
|
|
6811
|
-
},
|
|
6812
|
-
required: ['currency', 'quoteCurrency', 'amount', 'date']
|
|
6813
|
-
} as const;
|
|
6814
|
-
|
|
6815
|
-
export const $PriceResponseDto = {
|
|
6816
|
-
type: 'object',
|
|
6817
|
-
properties: {
|
|
6818
|
-
id: {
|
|
6819
|
-
type: 'string',
|
|
6820
|
-
description: 'Unique identifier',
|
|
6821
|
-
example: 'uuid-123-456'
|
|
6822
|
-
},
|
|
6823
|
-
userId: {
|
|
6824
|
-
type: 'string',
|
|
6825
|
-
description: 'User ID (owner of the price)',
|
|
6826
|
-
example: 'user-123'
|
|
6827
|
-
},
|
|
6828
|
-
currency: {
|
|
6829
|
-
type: 'string',
|
|
6830
|
-
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
6831
|
-
example: 'BTC'
|
|
6832
|
-
},
|
|
6833
|
-
quoteCurrency: {
|
|
6834
|
-
type: 'string',
|
|
6835
|
-
description: 'Quote currency (pricing currency, e.g., USD, CNY)',
|
|
6836
|
-
example: 'USD'
|
|
6837
|
-
},
|
|
6838
|
-
amount: {
|
|
6839
|
-
type: 'number',
|
|
6840
|
-
description:
|
|
6841
|
-
'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
|
|
6842
|
-
example: 50000
|
|
6843
|
-
},
|
|
6844
|
-
date: {
|
|
6845
|
-
type: 'string',
|
|
6846
|
-
description:
|
|
6847
|
-
'Price date (ISO 8601 format). Represents the date this price was valid.',
|
|
6848
|
-
example: '2024-01-01',
|
|
6849
|
-
format: 'date'
|
|
6850
|
-
},
|
|
6851
|
-
meta: {
|
|
6852
|
-
type: 'object',
|
|
6853
|
-
description:
|
|
6854
|
-
'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
|
|
6855
|
-
example: {
|
|
6856
|
-
source: 'MANUAL',
|
|
6857
|
-
note: 'User-defined price',
|
|
6858
|
-
confidence: 1
|
|
6859
|
-
}
|
|
6860
|
-
},
|
|
6861
|
-
createdAt: {
|
|
6862
|
-
format: 'date-time',
|
|
6863
|
-
type: 'string',
|
|
6864
|
-
description: 'Creation timestamp',
|
|
6865
|
-
example: '2024-11-03T10:00:00Z'
|
|
6866
|
-
},
|
|
6867
|
-
updatedAt: {
|
|
6868
|
-
format: 'date-time',
|
|
6869
|
-
type: 'string',
|
|
6870
|
-
description: 'Last update timestamp',
|
|
6871
|
-
example: '2024-11-03T10:00:00Z'
|
|
6872
|
-
}
|
|
6873
|
-
},
|
|
6874
|
-
required: [
|
|
6875
|
-
'id',
|
|
6876
|
-
'userId',
|
|
6877
|
-
'currency',
|
|
6878
|
-
'quoteCurrency',
|
|
6879
|
-
'amount',
|
|
6880
|
-
'date',
|
|
6881
|
-
'meta',
|
|
6882
|
-
'createdAt',
|
|
6883
|
-
'updatedAt'
|
|
6884
|
-
]
|
|
6885
|
-
} as const;
|
|
6886
|
-
|
|
6887
|
-
export const $PriceListResponseDto = {
|
|
6888
|
-
type: 'object',
|
|
6889
|
-
properties: {
|
|
6890
|
-
items: {
|
|
6891
|
-
description: 'List of prices',
|
|
6892
|
-
type: 'array',
|
|
6893
|
-
items: {
|
|
6894
|
-
$ref: '#/components/schemas/PriceResponseDto'
|
|
6895
|
-
}
|
|
6896
|
-
},
|
|
6897
|
-
total: {
|
|
6898
|
-
type: 'number',
|
|
6899
|
-
description: 'Total number of prices',
|
|
6900
|
-
example: 42
|
|
6901
|
-
}
|
|
6902
|
-
},
|
|
6903
|
-
required: ['items', 'total']
|
|
6904
|
-
} as const;
|
|
6905
|
-
|
|
6906
|
-
export const $UpdateBeanPriceDto = {
|
|
6907
|
-
type: 'object',
|
|
6908
|
-
properties: {
|
|
6909
|
-
currency: {
|
|
6910
|
-
type: 'string',
|
|
6911
|
-
description: 'Currency being priced'
|
|
6912
|
-
},
|
|
6913
|
-
quoteCurrency: {
|
|
6914
|
-
type: 'string',
|
|
6915
|
-
description: 'Quote currency (pricing currency)'
|
|
6916
|
-
},
|
|
6917
|
-
amount: {
|
|
6918
|
-
type: 'number',
|
|
6919
|
-
description: 'Price amount (MUST be >= 0 per Beancount spec)',
|
|
6920
|
-
minimum: 0
|
|
6921
|
-
},
|
|
6922
|
-
date: {
|
|
6923
|
-
type: 'string',
|
|
6924
|
-
description: 'Price date (ISO 8601 format)'
|
|
6925
|
-
},
|
|
6926
|
-
metadata: {
|
|
6927
|
-
type: 'object',
|
|
6928
|
-
description: 'Metadata'
|
|
6929
|
-
}
|
|
6930
|
-
}
|
|
8021
|
+
'accountPath',
|
|
8022
|
+
'symbol',
|
|
8023
|
+
'chartToken',
|
|
8024
|
+
'assetClass',
|
|
8025
|
+
'units'
|
|
8026
|
+
]
|
|
6931
8027
|
} as const;
|
|
6932
8028
|
|
|
6933
|
-
export const $
|
|
8029
|
+
export const $HoldingPnlWarningDto = {
|
|
6934
8030
|
type: 'object',
|
|
6935
8031
|
properties: {
|
|
6936
|
-
|
|
8032
|
+
type: {
|
|
6937
8033
|
type: 'string',
|
|
6938
|
-
description: '
|
|
6939
|
-
example: '
|
|
8034
|
+
description: 'Warning type',
|
|
8035
|
+
example: 'MISSING_COST_FX_RATE',
|
|
8036
|
+
enum: [
|
|
8037
|
+
'MISSING_COST_FX_RATE',
|
|
8038
|
+
'MISSING_MARKET_FX_RATE',
|
|
8039
|
+
'MISSING_SALE_PRICE',
|
|
8040
|
+
'MISSING_REALIZED_FX_RATE',
|
|
8041
|
+
'OVERSOLD_LOTS',
|
|
8042
|
+
'NO_PRICE',
|
|
8043
|
+
'MIXED_COST_CURRENCY'
|
|
8044
|
+
]
|
|
6940
8045
|
},
|
|
6941
|
-
|
|
6942
|
-
type: '
|
|
6943
|
-
|
|
6944
|
-
|
|
8046
|
+
symbol: {
|
|
8047
|
+
type: 'object',
|
|
8048
|
+
nullable: true
|
|
8049
|
+
},
|
|
8050
|
+
accountId: {
|
|
8051
|
+
type: 'object',
|
|
8052
|
+
nullable: true
|
|
8053
|
+
},
|
|
8054
|
+
currency: {
|
|
8055
|
+
type: 'object',
|
|
8056
|
+
nullable: true
|
|
6945
8057
|
}
|
|
6946
8058
|
},
|
|
6947
|
-
required: ['
|
|
8059
|
+
required: ['type']
|
|
6948
8060
|
} as const;
|
|
6949
8061
|
|
|
6950
|
-
export const $
|
|
8062
|
+
export const $HoldingPnlResponseDto = {
|
|
6951
8063
|
type: 'object',
|
|
6952
8064
|
properties: {
|
|
6953
|
-
|
|
8065
|
+
asOfDate: {
|
|
6954
8066
|
type: 'string',
|
|
6955
|
-
|
|
6956
|
-
example: '2024-06-15'
|
|
8067
|
+
example: '2026-07-08'
|
|
6957
8068
|
},
|
|
6958
|
-
|
|
8069
|
+
baseCurrency: {
|
|
6959
8070
|
type: 'string',
|
|
6960
|
-
|
|
6961
|
-
example: '500000.00'
|
|
8071
|
+
example: 'CNY'
|
|
6962
8072
|
},
|
|
6963
|
-
|
|
6964
|
-
type: '
|
|
6965
|
-
description:
|
|
6966
|
-
|
|
8073
|
+
method: {
|
|
8074
|
+
type: 'string',
|
|
8075
|
+
description:
|
|
8076
|
+
'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
|
|
8077
|
+
enum: ['average', 'FIFO'],
|
|
8078
|
+
example: 'average'
|
|
6967
8079
|
},
|
|
6968
|
-
|
|
6969
|
-
description: 'Multi-currency breakdown for this point',
|
|
8080
|
+
rows: {
|
|
6970
8081
|
type: 'array',
|
|
6971
8082
|
items: {
|
|
6972
|
-
$ref: '#/components/schemas/
|
|
8083
|
+
$ref: '#/components/schemas/HoldingPnlRowDto'
|
|
8084
|
+
}
|
|
8085
|
+
},
|
|
8086
|
+
warnings: {
|
|
8087
|
+
type: 'array',
|
|
8088
|
+
items: {
|
|
8089
|
+
$ref: '#/components/schemas/HoldingPnlWarningDto'
|
|
6973
8090
|
}
|
|
6974
8091
|
}
|
|
6975
8092
|
},
|
|
6976
|
-
required: ['
|
|
8093
|
+
required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
|
|
6977
8094
|
} as const;
|
|
6978
8095
|
|
|
6979
|
-
export const $
|
|
8096
|
+
export const $AnonymousLoginDto = {
|
|
6980
8097
|
type: 'object',
|
|
6981
8098
|
properties: {
|
|
6982
|
-
|
|
6983
|
-
type: 'string',
|
|
6984
|
-
description: 'Value at start of period',
|
|
6985
|
-
example: '450000.00'
|
|
6986
|
-
},
|
|
6987
|
-
endValue: {
|
|
6988
|
-
type: 'string',
|
|
6989
|
-
description: 'Value at end of period',
|
|
6990
|
-
example: '500000.00'
|
|
6991
|
-
},
|
|
6992
|
-
totalChange: {
|
|
6993
|
-
type: 'string',
|
|
6994
|
-
description: 'Total change over period',
|
|
6995
|
-
example: '50000.00'
|
|
6996
|
-
},
|
|
6997
|
-
totalChangePercentage: {
|
|
8099
|
+
accessToken: {
|
|
6998
8100
|
type: 'string',
|
|
6999
|
-
description: '
|
|
7000
|
-
example: '+11.11%'
|
|
8101
|
+
description: 'Access token for anonymous login'
|
|
7001
8102
|
}
|
|
7002
8103
|
},
|
|
7003
|
-
required: ['
|
|
8104
|
+
required: ['accessToken']
|
|
7004
8105
|
} as const;
|
|
7005
8106
|
|
|
7006
|
-
export const $
|
|
8107
|
+
export const $AnonymousLoginResponseDto = {
|
|
7007
8108
|
type: 'object',
|
|
7008
8109
|
properties: {
|
|
7009
|
-
|
|
8110
|
+
authToken: {
|
|
7010
8111
|
type: 'string',
|
|
7011
|
-
description: '
|
|
7012
|
-
example: '
|
|
7013
|
-
},
|
|
7014
|
-
byCurrency: {
|
|
7015
|
-
description: 'Balances by currency',
|
|
7016
|
-
type: 'array',
|
|
7017
|
-
items: {
|
|
7018
|
-
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
7019
|
-
}
|
|
8112
|
+
description: 'JWT auth token',
|
|
8113
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
7020
8114
|
}
|
|
7021
8115
|
},
|
|
7022
|
-
required: ['
|
|
8116
|
+
required: ['authToken']
|
|
7023
8117
|
} as const;
|
|
7024
8118
|
|
|
7025
|
-
export const $
|
|
8119
|
+
export const $SymbolSearchResultDto = {
|
|
7026
8120
|
type: 'object',
|
|
7027
8121
|
properties: {
|
|
7028
|
-
|
|
7029
|
-
|
|
7030
|
-
|
|
7031
|
-
items: {
|
|
7032
|
-
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
7033
|
-
}
|
|
8122
|
+
symbol: {
|
|
8123
|
+
type: 'string',
|
|
8124
|
+
example: 'AAPL'
|
|
7034
8125
|
},
|
|
7035
|
-
|
|
7036
|
-
|
|
7037
|
-
|
|
7038
|
-
|
|
7039
|
-
$ref: '#/components/schemas/TrendSummaryDto'
|
|
7040
|
-
}
|
|
7041
|
-
]
|
|
8126
|
+
name: {
|
|
8127
|
+
type: 'object',
|
|
8128
|
+
example: 'Apple Inc.',
|
|
8129
|
+
nullable: true
|
|
7042
8130
|
},
|
|
7043
|
-
|
|
7044
|
-
type: '
|
|
7045
|
-
|
|
7046
|
-
|
|
8131
|
+
exchange: {
|
|
8132
|
+
type: 'object',
|
|
8133
|
+
example: 'US',
|
|
8134
|
+
nullable: true
|
|
7047
8135
|
},
|
|
7048
|
-
|
|
7049
|
-
type: '
|
|
7050
|
-
description: '
|
|
7051
|
-
example: '
|
|
8136
|
+
assetType: {
|
|
8137
|
+
type: 'object',
|
|
8138
|
+
description: 'OpenBB asset_type (e.g. stock, etf)',
|
|
8139
|
+
example: 'stock',
|
|
8140
|
+
nullable: true
|
|
7052
8141
|
},
|
|
7053
|
-
|
|
7054
|
-
type: '
|
|
7055
|
-
description: '
|
|
7056
|
-
example: '
|
|
8142
|
+
assetClass: {
|
|
8143
|
+
type: 'object',
|
|
8144
|
+
description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
|
|
8145
|
+
example: 'EQUITY',
|
|
8146
|
+
nullable: true
|
|
7057
8147
|
},
|
|
7058
|
-
|
|
7059
|
-
|
|
7060
|
-
|
|
7061
|
-
|
|
7062
|
-
|
|
7063
|
-
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
7064
|
-
}
|
|
8148
|
+
assetSubClass: {
|
|
8149
|
+
type: 'object',
|
|
8150
|
+
description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
|
|
8151
|
+
example: 'STOCK',
|
|
8152
|
+
nullable: true
|
|
7065
8153
|
},
|
|
7066
|
-
|
|
7067
|
-
|
|
7068
|
-
|
|
7069
|
-
|
|
7070
|
-
|
|
7071
|
-
}
|
|
8154
|
+
currency: {
|
|
8155
|
+
type: 'object',
|
|
8156
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8157
|
+
example: 'USD',
|
|
8158
|
+
nullable: true
|
|
7072
8159
|
}
|
|
7073
8160
|
},
|
|
7074
|
-
required: ['
|
|
7075
|
-
} as const;
|
|
7076
|
-
|
|
7077
|
-
export const $GenerateSnapshotBody = {
|
|
7078
|
-
type: 'object',
|
|
7079
|
-
properties: {}
|
|
7080
|
-
} as const;
|
|
7081
|
-
|
|
7082
|
-
export const $GenerateSnapshotResponse = {
|
|
7083
|
-
type: 'object',
|
|
7084
|
-
properties: {}
|
|
7085
|
-
} as const;
|
|
7086
|
-
|
|
7087
|
-
export const $BackfillSnapshotsBody = {
|
|
7088
|
-
type: 'object',
|
|
7089
|
-
properties: {}
|
|
7090
|
-
} as const;
|
|
7091
|
-
|
|
7092
|
-
export const $BackfillSnapshotsResponse = {
|
|
7093
|
-
type: 'object',
|
|
7094
|
-
properties: {}
|
|
8161
|
+
required: ['symbol']
|
|
7095
8162
|
} as const;
|
|
7096
8163
|
|
|
7097
|
-
export const $
|
|
8164
|
+
export const $SymbolQuoteDto = {
|
|
7098
8165
|
type: 'object',
|
|
7099
8166
|
properties: {
|
|
7100
|
-
|
|
8167
|
+
symbol: {
|
|
7101
8168
|
type: 'string',
|
|
7102
|
-
|
|
8169
|
+
example: 'AAPL'
|
|
8170
|
+
},
|
|
8171
|
+
name: {
|
|
8172
|
+
type: 'object',
|
|
8173
|
+
example: 'Apple Inc.',
|
|
8174
|
+
nullable: true
|
|
8175
|
+
},
|
|
8176
|
+
exchange: {
|
|
8177
|
+
type: 'object',
|
|
8178
|
+
example: 'US',
|
|
8179
|
+
nullable: true
|
|
8180
|
+
},
|
|
8181
|
+
assetType: {
|
|
8182
|
+
type: 'object',
|
|
8183
|
+
description: 'OpenBB asset_type',
|
|
8184
|
+
example: 'stock',
|
|
8185
|
+
nullable: true
|
|
8186
|
+
},
|
|
8187
|
+
assetClass: {
|
|
8188
|
+
type: 'object',
|
|
8189
|
+
description: 'IGN asset class',
|
|
8190
|
+
example: 'EQUITY',
|
|
8191
|
+
nullable: true
|
|
8192
|
+
},
|
|
8193
|
+
assetSubClass: {
|
|
8194
|
+
type: 'object',
|
|
8195
|
+
description: 'IGN asset sub-class',
|
|
8196
|
+
example: 'STOCK',
|
|
8197
|
+
nullable: true
|
|
8198
|
+
},
|
|
8199
|
+
currency: {
|
|
8200
|
+
type: 'object',
|
|
8201
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8202
|
+
example: 'USD',
|
|
8203
|
+
nullable: true
|
|
8204
|
+
},
|
|
8205
|
+
price: {
|
|
8206
|
+
type: 'object',
|
|
8207
|
+
description: 'Latest price (Decimal string)',
|
|
8208
|
+
example: '189.84',
|
|
8209
|
+
nullable: true
|
|
8210
|
+
},
|
|
8211
|
+
priceDate: {
|
|
8212
|
+
type: 'object',
|
|
8213
|
+
description: 'Date the price was observed (ISO yyyy-MM-dd)',
|
|
8214
|
+
example: '2026-08-05',
|
|
8215
|
+
nullable: true
|
|
8216
|
+
},
|
|
8217
|
+
changePercent: {
|
|
8218
|
+
type: 'object',
|
|
8219
|
+
description:
|
|
8220
|
+
'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.',
|
|
8221
|
+
example: 1.7,
|
|
8222
|
+
nullable: true
|
|
8223
|
+
},
|
|
8224
|
+
prevClose: {
|
|
8225
|
+
type: 'object',
|
|
8226
|
+
description: 'Previous close (Decimal string)',
|
|
8227
|
+
nullable: true
|
|
8228
|
+
},
|
|
8229
|
+
open: {
|
|
8230
|
+
type: 'object',
|
|
8231
|
+
description: 'Day open (Decimal string)',
|
|
8232
|
+
nullable: true
|
|
8233
|
+
},
|
|
8234
|
+
high: {
|
|
8235
|
+
type: 'object',
|
|
8236
|
+
description: 'Day high (Decimal string)',
|
|
8237
|
+
nullable: true
|
|
8238
|
+
},
|
|
8239
|
+
low: {
|
|
8240
|
+
type: 'object',
|
|
8241
|
+
description: 'Day low (Decimal string)',
|
|
8242
|
+
nullable: true
|
|
8243
|
+
},
|
|
8244
|
+
volume: {
|
|
8245
|
+
type: 'object',
|
|
8246
|
+
description: 'Day volume (Decimal string)',
|
|
8247
|
+
nullable: true
|
|
8248
|
+
},
|
|
8249
|
+
yearHigh: {
|
|
8250
|
+
type: 'object',
|
|
8251
|
+
description: '52-week high (Decimal string)',
|
|
8252
|
+
nullable: true
|
|
8253
|
+
},
|
|
8254
|
+
yearLow: {
|
|
8255
|
+
type: 'object',
|
|
8256
|
+
description: '52-week low (Decimal string)',
|
|
8257
|
+
nullable: true
|
|
7103
8258
|
}
|
|
7104
|
-
}
|
|
7105
|
-
required: ['accessToken']
|
|
8259
|
+
}
|
|
7106
8260
|
} as const;
|