@firela/api-types 0.0.0-canary.cf050c09 → 0.0.0-canary.d41ffbd5
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 +4472 -2524
- package/dist/index.d.ts +4472 -2524
- package/dist/index.js +34 -6
- package/dist/index.mjs +34 -6
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +2552 -623
- package/src/generated/services.gen.ts +1283 -414
- package/src/generated/types.gen.ts +7749 -2909
|
@@ -6,18 +6,12 @@ export const $CreateAccountDto = {
|
|
|
6
6
|
path: {
|
|
7
7
|
type: 'string',
|
|
8
8
|
description: 'Account path (hierarchical, colon-separated)',
|
|
9
|
-
example: 'Assets:CN:
|
|
10
|
-
},
|
|
11
|
-
displayName: {
|
|
12
|
-
type: 'string',
|
|
13
|
-
description:
|
|
14
|
-
'Display name to distinguish accounts at the same path (default: "")',
|
|
15
|
-
example: '工资卡'
|
|
9
|
+
example: 'Assets:CN:ICBC:Checking'
|
|
16
10
|
},
|
|
17
11
|
openDate: {
|
|
18
12
|
format: 'date-time',
|
|
19
13
|
type: 'string',
|
|
20
|
-
description: 'Account open date',
|
|
14
|
+
description: 'Account open date (server defaults to today)',
|
|
21
15
|
example: '2024-01-01'
|
|
22
16
|
},
|
|
23
17
|
currencies: {
|
|
@@ -45,26 +39,22 @@ export const $CreateAccountDto = {
|
|
|
45
39
|
templatePath: {
|
|
46
40
|
type: 'string',
|
|
47
41
|
description: 'Reference to account-standards template path',
|
|
48
|
-
example: 'Assets:CN:
|
|
42
|
+
example: 'Assets:CN:Checking'
|
|
49
43
|
},
|
|
50
44
|
isCustom: {
|
|
51
45
|
type: 'boolean',
|
|
52
46
|
description: 'Whether this is a custom (user-created) account',
|
|
53
47
|
default: false
|
|
54
48
|
},
|
|
55
|
-
i18nKey: {
|
|
56
|
-
type: 'string',
|
|
57
|
-
description: 'i18n key for display name (overrides template)',
|
|
58
|
-
example: 'account.custom.mybank'
|
|
59
|
-
},
|
|
60
49
|
icon: {
|
|
61
50
|
type: 'string',
|
|
62
51
|
description: 'Icon identifier (overrides template)',
|
|
63
52
|
example: 'bank-custom'
|
|
64
53
|
},
|
|
65
|
-
|
|
54
|
+
openDirectiveMeta: {
|
|
66
55
|
type: 'object',
|
|
67
|
-
description:
|
|
56
|
+
description:
|
|
57
|
+
'Open directive metadata (NOT an opening-balance amount — use the opening-balance endpoint)',
|
|
68
58
|
example: {
|
|
69
59
|
branch: 'Downtown',
|
|
70
60
|
accountNumber: '1234'
|
|
@@ -76,7 +66,7 @@ export const $CreateAccountDto = {
|
|
|
76
66
|
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
77
67
|
}
|
|
78
68
|
},
|
|
79
|
-
required: ['path'
|
|
69
|
+
required: ['path']
|
|
80
70
|
} as const;
|
|
81
71
|
|
|
82
72
|
export const $AccountResponseDto = {
|
|
@@ -90,13 +80,7 @@ export const $AccountResponseDto = {
|
|
|
90
80
|
path: {
|
|
91
81
|
type: 'string',
|
|
92
82
|
description: 'Account path (hierarchical, colon-separated)',
|
|
93
|
-
example: 'Assets:CN:
|
|
94
|
-
},
|
|
95
|
-
displayName: {
|
|
96
|
-
type: 'string',
|
|
97
|
-
description:
|
|
98
|
-
'Display name distinguishing multiple accounts at the same path',
|
|
99
|
-
example: '工资卡'
|
|
83
|
+
example: 'Assets:CN:ICBC:Checking'
|
|
100
84
|
},
|
|
101
85
|
type: {
|
|
102
86
|
type: 'string',
|
|
@@ -104,6 +88,49 @@ export const $AccountResponseDto = {
|
|
|
104
88
|
enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
|
|
105
89
|
example: 'Assets'
|
|
106
90
|
},
|
|
91
|
+
assetSubClass: {
|
|
92
|
+
type: 'string',
|
|
93
|
+
description:
|
|
94
|
+
'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
|
|
95
|
+
enum: [
|
|
96
|
+
'DEPOSIT',
|
|
97
|
+
'CASH',
|
|
98
|
+
'MONEY_MARKET_FUND',
|
|
99
|
+
'STOCK',
|
|
100
|
+
'ETF',
|
|
101
|
+
'MUTUAL_FUND',
|
|
102
|
+
'EQUITY_COMPENSATION',
|
|
103
|
+
'GOVERNMENT_BOND',
|
|
104
|
+
'CORPORATE_BOND',
|
|
105
|
+
'BOND_FUND',
|
|
106
|
+
'PRIMARY_RESIDENCE',
|
|
107
|
+
'INVESTMENT_PROPERTY',
|
|
108
|
+
'REIT',
|
|
109
|
+
'GOLD',
|
|
110
|
+
'SILVER',
|
|
111
|
+
'PRECIOUS_METAL',
|
|
112
|
+
'PRECIOUS_METAL_FUND',
|
|
113
|
+
'COMMODITY',
|
|
114
|
+
'COMMODITY_FUND',
|
|
115
|
+
'CRYPTOCURRENCY',
|
|
116
|
+
'RETIREMENT_ACCOUNT',
|
|
117
|
+
'HEALTH_ACCOUNT',
|
|
118
|
+
'EDUCATION_ACCOUNT',
|
|
119
|
+
'INSURANCE',
|
|
120
|
+
'PRIVATE_EQUITY',
|
|
121
|
+
'HEDGE_FUND',
|
|
122
|
+
'COLLECTIBLES',
|
|
123
|
+
'MORTGAGE',
|
|
124
|
+
'STUDENT_LOAN',
|
|
125
|
+
'CREDIT_CARD',
|
|
126
|
+
'PERSONAL_LOAN',
|
|
127
|
+
'ACCOUNTS_PAYABLE',
|
|
128
|
+
'TAX_PAYABLE',
|
|
129
|
+
'OTHER'
|
|
130
|
+
],
|
|
131
|
+
nullable: true,
|
|
132
|
+
example: 'STOCK'
|
|
133
|
+
},
|
|
107
134
|
status: {
|
|
108
135
|
type: 'string',
|
|
109
136
|
description: 'Account status',
|
|
@@ -145,26 +172,26 @@ export const $AccountResponseDto = {
|
|
|
145
172
|
templatePath: {
|
|
146
173
|
type: 'string',
|
|
147
174
|
description: 'Template path reference',
|
|
148
|
-
example: 'Assets:CN:
|
|
175
|
+
example: 'Assets:CN:Checking'
|
|
149
176
|
},
|
|
150
177
|
isCustom: {
|
|
151
178
|
type: 'boolean',
|
|
152
179
|
description: 'Whether this is a custom (user-created) account',
|
|
153
180
|
example: false
|
|
154
181
|
},
|
|
155
|
-
|
|
182
|
+
displayName: {
|
|
156
183
|
type: 'string',
|
|
157
|
-
description: '
|
|
158
|
-
example: '
|
|
184
|
+
description: 'Localized display name (ADR-0114, read-time projection)',
|
|
185
|
+
example: 'Checking'
|
|
159
186
|
},
|
|
160
187
|
icon: {
|
|
161
188
|
type: 'string',
|
|
162
189
|
description: 'Icon identifier',
|
|
163
190
|
example: 'bank-icbc'
|
|
164
191
|
},
|
|
165
|
-
|
|
192
|
+
openDirectiveMeta: {
|
|
166
193
|
type: 'object',
|
|
167
|
-
description: '
|
|
194
|
+
description: 'Open directive metadata (ADR-0115 Decision 9)',
|
|
168
195
|
example: {
|
|
169
196
|
branch: 'Downtown'
|
|
170
197
|
}
|
|
@@ -192,7 +219,6 @@ export const $AccountResponseDto = {
|
|
|
192
219
|
required: [
|
|
193
220
|
'id',
|
|
194
221
|
'path',
|
|
195
|
-
'displayName',
|
|
196
222
|
'type',
|
|
197
223
|
'status',
|
|
198
224
|
'openDate',
|
|
@@ -225,11 +251,6 @@ export const $AccountListResponseDto = {
|
|
|
225
251
|
export const $UpdateAccountDto = {
|
|
226
252
|
type: 'object',
|
|
227
253
|
properties: {
|
|
228
|
-
displayName: {
|
|
229
|
-
type: 'string',
|
|
230
|
-
description: 'Display name to distinguish accounts at the same path',
|
|
231
|
-
example: '招行工资卡'
|
|
232
|
-
},
|
|
233
254
|
currencies: {
|
|
234
255
|
description: 'Allowed currencies (null = no restriction)',
|
|
235
256
|
example: ['CNY', 'USD'],
|
|
@@ -251,19 +272,15 @@ export const $UpdateAccountDto = {
|
|
|
251
272
|
'NONE'
|
|
252
273
|
]
|
|
253
274
|
},
|
|
254
|
-
i18nKey: {
|
|
255
|
-
type: 'string',
|
|
256
|
-
description: 'i18n key for display name',
|
|
257
|
-
example: 'account.custom.mybank'
|
|
258
|
-
},
|
|
259
275
|
icon: {
|
|
260
276
|
type: 'string',
|
|
261
277
|
description: 'Icon identifier',
|
|
262
278
|
example: 'bank-custom'
|
|
263
279
|
},
|
|
264
|
-
|
|
280
|
+
openDirectiveMeta: {
|
|
265
281
|
type: 'object',
|
|
266
|
-
description:
|
|
282
|
+
description:
|
|
283
|
+
'Open directive metadata (merged with existing; NOT an opening-balance amount)',
|
|
267
284
|
example: {
|
|
268
285
|
branch: 'Uptown'
|
|
269
286
|
}
|
|
@@ -310,13 +327,47 @@ export const $ReopenAccountDto = {
|
|
|
310
327
|
}
|
|
311
328
|
} as const;
|
|
312
329
|
|
|
330
|
+
export const $CreateOpeningBalanceDto = {
|
|
331
|
+
type: 'object',
|
|
332
|
+
properties: {
|
|
333
|
+
amount: {
|
|
334
|
+
type: 'number',
|
|
335
|
+
description: 'Opening balance amount (non-negative)',
|
|
336
|
+
example: 1000
|
|
337
|
+
},
|
|
338
|
+
currency: {
|
|
339
|
+
type: 'string',
|
|
340
|
+
description: 'Currency code',
|
|
341
|
+
example: 'CNY'
|
|
342
|
+
},
|
|
343
|
+
date: {
|
|
344
|
+
format: 'date-time',
|
|
345
|
+
type: 'string',
|
|
346
|
+
description: 'Opening-balance date (defaults to now)',
|
|
347
|
+
example: '2024-01-01'
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
required: ['amount', 'currency']
|
|
351
|
+
} as const;
|
|
352
|
+
|
|
353
|
+
export const $OpeningBalanceResultDto = {
|
|
354
|
+
type: 'object',
|
|
355
|
+
properties: {
|
|
356
|
+
transactionId: {
|
|
357
|
+
type: 'string',
|
|
358
|
+
description: 'Created opening-balance transaction id.'
|
|
359
|
+
}
|
|
360
|
+
},
|
|
361
|
+
required: ['transactionId']
|
|
362
|
+
} as const;
|
|
363
|
+
|
|
313
364
|
export const $AccountStandardResponseDto = {
|
|
314
365
|
type: 'object',
|
|
315
366
|
properties: {
|
|
316
367
|
path: {
|
|
317
368
|
type: 'string',
|
|
318
369
|
description: 'Account path (hierarchical, colon-separated)',
|
|
319
|
-
example: 'Assets:CN:
|
|
370
|
+
example: 'Assets:CN:Checking'
|
|
320
371
|
},
|
|
321
372
|
type: {
|
|
322
373
|
type: 'string',
|
|
@@ -324,11 +375,6 @@ export const $AccountStandardResponseDto = {
|
|
|
324
375
|
enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
|
|
325
376
|
example: 'Assets'
|
|
326
377
|
},
|
|
327
|
-
i18nKey: {
|
|
328
|
-
type: 'string',
|
|
329
|
-
description: 'i18n key for localized display name',
|
|
330
|
-
example: 'account.assets.cn.bank.icbc.checking'
|
|
331
|
-
},
|
|
332
378
|
name: {
|
|
333
379
|
type: 'string',
|
|
334
380
|
description: 'Short localized display name',
|
|
@@ -351,9 +397,47 @@ export const $AccountStandardResponseDto = {
|
|
|
351
397
|
type: 'string',
|
|
352
398
|
description: 'Icon identifier for UI display',
|
|
353
399
|
example: 'bank-icbc'
|
|
400
|
+
},
|
|
401
|
+
productCategory: {
|
|
402
|
+
type: 'string',
|
|
403
|
+
description:
|
|
404
|
+
'Onboarding product category (coarse grouping derived from assetSubClass)',
|
|
405
|
+
enum: [
|
|
406
|
+
'cash',
|
|
407
|
+
'investment',
|
|
408
|
+
'credit_card',
|
|
409
|
+
'loan',
|
|
410
|
+
'payable_tax',
|
|
411
|
+
'other'
|
|
412
|
+
],
|
|
413
|
+
example: 'investment'
|
|
414
|
+
},
|
|
415
|
+
assetClass: {
|
|
416
|
+
type: 'string',
|
|
417
|
+
description:
|
|
418
|
+
'Asset class (LIQUIDITY/EQUITY/.../LIABILITY), derived at read time from classification rules',
|
|
419
|
+
enum: [
|
|
420
|
+
'LIQUIDITY',
|
|
421
|
+
'EQUITY',
|
|
422
|
+
'FIXED_INCOME',
|
|
423
|
+
'PRECIOUS_METALS',
|
|
424
|
+
'COMMODITY',
|
|
425
|
+
'INSURANCE',
|
|
426
|
+
'ALTERNATIVE_INVESTMENT',
|
|
427
|
+
'PERSONAL_ASSETS',
|
|
428
|
+
'LIABILITY',
|
|
429
|
+
'REAL_ESTATE',
|
|
430
|
+
'INDEX'
|
|
431
|
+
]
|
|
432
|
+
},
|
|
433
|
+
assetSubClass: {
|
|
434
|
+
type: 'string',
|
|
435
|
+
description:
|
|
436
|
+
'Asset sub-class (product type, derived at read time from classification rules)',
|
|
437
|
+
example: 'STOCK'
|
|
354
438
|
}
|
|
355
439
|
},
|
|
356
|
-
required: ['path', 'type', '
|
|
440
|
+
required: ['path', 'type', 'description', 'tags', 'icon', 'productCategory']
|
|
357
441
|
} as const;
|
|
358
442
|
|
|
359
443
|
export const $AccountStandardListResponseDto = {
|
|
@@ -383,18 +467,13 @@ export const $AccountStandardListResponseDto = {
|
|
|
383
467
|
export const $TemplateMetadataDto = {
|
|
384
468
|
type: 'object',
|
|
385
469
|
properties: {
|
|
386
|
-
extendable: {
|
|
387
|
-
type: 'boolean',
|
|
388
|
-
description: 'Whether this path can be extended',
|
|
389
|
-
example: true
|
|
390
|
-
},
|
|
391
470
|
rootType: {
|
|
392
471
|
type: 'string',
|
|
393
472
|
description: 'Root account type',
|
|
394
473
|
example: 'Assets'
|
|
395
474
|
}
|
|
396
475
|
},
|
|
397
|
-
required: ['
|
|
476
|
+
required: ['rootType']
|
|
398
477
|
} as const;
|
|
399
478
|
|
|
400
479
|
export const $TemplateMetadataResponseDto = {
|
|
@@ -466,6 +545,66 @@ export const $RegionsMetadataResponseDto = {
|
|
|
466
545
|
required: ['regions']
|
|
467
546
|
} as const;
|
|
468
547
|
|
|
548
|
+
export const $CostSpecDto = {
|
|
549
|
+
type: 'object',
|
|
550
|
+
properties: {
|
|
551
|
+
mode: {
|
|
552
|
+
type: 'string',
|
|
553
|
+
enum: ['per-unit', 'total', 'date', 'label', 'auto'],
|
|
554
|
+
description: 'Cost specification mode (mirrors engine CostSpec)'
|
|
555
|
+
},
|
|
556
|
+
numberPerUnit: {
|
|
557
|
+
type: 'string',
|
|
558
|
+
description: 'Per-unit cost (required when mode is "per-unit")',
|
|
559
|
+
example: '240'
|
|
560
|
+
},
|
|
561
|
+
totalNumber: {
|
|
562
|
+
type: 'string',
|
|
563
|
+
description: 'Total cost for all units (required when mode is "total")',
|
|
564
|
+
example: '12000'
|
|
565
|
+
},
|
|
566
|
+
currency: {
|
|
567
|
+
type: 'string',
|
|
568
|
+
description: 'Cost currency (required in all modes)',
|
|
569
|
+
example: 'USD'
|
|
570
|
+
},
|
|
571
|
+
date: {
|
|
572
|
+
type: 'string',
|
|
573
|
+
description:
|
|
574
|
+
'Lot acquisition date, ISO 8601 (required when mode is "date")',
|
|
575
|
+
example: '2024-01-15'
|
|
576
|
+
},
|
|
577
|
+
label: {
|
|
578
|
+
type: 'string',
|
|
579
|
+
description:
|
|
580
|
+
'Lot label (required when mode is "label"; optional tag in buy modes)'
|
|
581
|
+
},
|
|
582
|
+
merge: {
|
|
583
|
+
type: 'boolean',
|
|
584
|
+
description: 'Merge lots for AVERAGE booking (mode: auto)'
|
|
585
|
+
}
|
|
586
|
+
},
|
|
587
|
+
required: ['mode', 'currency']
|
|
588
|
+
} as const;
|
|
589
|
+
|
|
590
|
+
export const $AmountDto = {
|
|
591
|
+
type: 'object',
|
|
592
|
+
properties: {
|
|
593
|
+
number: {
|
|
594
|
+
type: 'string',
|
|
595
|
+
description:
|
|
596
|
+
'Amount as decimal string (max 15 integer + 15 decimal digits)',
|
|
597
|
+
example: '170.50'
|
|
598
|
+
},
|
|
599
|
+
currency: {
|
|
600
|
+
type: 'string',
|
|
601
|
+
description: 'Currency/commodity code',
|
|
602
|
+
example: 'USD'
|
|
603
|
+
}
|
|
604
|
+
},
|
|
605
|
+
required: ['number', 'currency']
|
|
606
|
+
} as const;
|
|
607
|
+
|
|
469
608
|
export const $CreatePostingDto = {
|
|
470
609
|
type: 'object',
|
|
471
610
|
properties: {
|
|
@@ -473,7 +612,7 @@ export const $CreatePostingDto = {
|
|
|
473
612
|
type: 'string',
|
|
474
613
|
description:
|
|
475
614
|
'Account name in Beancount format (must start with uppercase, colon-separated)',
|
|
476
|
-
example: 'Assets:
|
|
615
|
+
example: 'Assets:Checking'
|
|
477
616
|
},
|
|
478
617
|
units: {
|
|
479
618
|
type: 'string',
|
|
@@ -495,6 +634,33 @@ export const $CreatePostingDto = {
|
|
|
495
634
|
example: {
|
|
496
635
|
'tax-lot': 'Q1-2024'
|
|
497
636
|
}
|
|
637
|
+
},
|
|
638
|
+
cost: {
|
|
639
|
+
description:
|
|
640
|
+
'Cost basis (Beancount `{...}`). Maps to engine costSpec. Required for commodity holdings so they carry a monetary weight that can balance.',
|
|
641
|
+
example: {
|
|
642
|
+
mode: 'per-unit',
|
|
643
|
+
numberPerUnit: '240',
|
|
644
|
+
currency: 'USD'
|
|
645
|
+
},
|
|
646
|
+
allOf: [
|
|
647
|
+
{
|
|
648
|
+
$ref: '#/components/schemas/CostSpecDto'
|
|
649
|
+
}
|
|
650
|
+
]
|
|
651
|
+
},
|
|
652
|
+
price: {
|
|
653
|
+
description:
|
|
654
|
+
'Price annotation (Beancount `@...`). Maps to engine price. Used for valuation; cost takes priority for balance weight.',
|
|
655
|
+
example: {
|
|
656
|
+
number: '170',
|
|
657
|
+
currency: 'USD'
|
|
658
|
+
},
|
|
659
|
+
allOf: [
|
|
660
|
+
{
|
|
661
|
+
$ref: '#/components/schemas/AmountDto'
|
|
662
|
+
}
|
|
663
|
+
]
|
|
498
664
|
}
|
|
499
665
|
},
|
|
500
666
|
required: ['account']
|
|
@@ -573,13 +739,39 @@ export const $CreateTransactionDto = {
|
|
|
573
739
|
required: ['date', 'narration', 'postings']
|
|
574
740
|
} as const;
|
|
575
741
|
|
|
742
|
+
export const $CostDetailDto = {
|
|
743
|
+
type: 'object',
|
|
744
|
+
properties: {
|
|
745
|
+
number: {
|
|
746
|
+
type: 'string',
|
|
747
|
+
description: 'Per-unit cost basis (mirrors engine Cost.number)',
|
|
748
|
+
example: '240'
|
|
749
|
+
},
|
|
750
|
+
currency: {
|
|
751
|
+
type: 'string',
|
|
752
|
+
description: 'Cost currency',
|
|
753
|
+
example: 'USD'
|
|
754
|
+
},
|
|
755
|
+
date: {
|
|
756
|
+
type: 'string',
|
|
757
|
+
description: 'Lot acquisition date (ISO yyyy-mm-dd)',
|
|
758
|
+
example: '2024-01-15'
|
|
759
|
+
},
|
|
760
|
+
label: {
|
|
761
|
+
type: 'string',
|
|
762
|
+
description: 'Lot label',
|
|
763
|
+
example: 'lot-2024-01'
|
|
764
|
+
}
|
|
765
|
+
}
|
|
766
|
+
} as const;
|
|
767
|
+
|
|
576
768
|
export const $PostingResponseDto = {
|
|
577
769
|
type: 'object',
|
|
578
770
|
properties: {
|
|
579
771
|
account: {
|
|
580
772
|
type: 'string',
|
|
581
773
|
description: 'Account name',
|
|
582
|
-
example: 'Assets:
|
|
774
|
+
example: 'Assets:Checking'
|
|
583
775
|
},
|
|
584
776
|
units: {
|
|
585
777
|
type: 'string',
|
|
@@ -591,6 +783,15 @@ export const $PostingResponseDto = {
|
|
|
591
783
|
type: 'string',
|
|
592
784
|
description: 'Currency',
|
|
593
785
|
example: 'USD'
|
|
786
|
+
},
|
|
787
|
+
cost: {
|
|
788
|
+
description:
|
|
789
|
+
'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
|
|
790
|
+
allOf: [
|
|
791
|
+
{
|
|
792
|
+
$ref: '#/components/schemas/CostDetailDto'
|
|
793
|
+
}
|
|
794
|
+
]
|
|
594
795
|
}
|
|
595
796
|
},
|
|
596
797
|
required: ['account']
|
|
@@ -933,10 +1134,10 @@ export const $PostingDetailDto = {
|
|
|
933
1134
|
description: 'Account ID',
|
|
934
1135
|
example: 'clh1234567890abcdef'
|
|
935
1136
|
},
|
|
936
|
-
|
|
1137
|
+
account: {
|
|
937
1138
|
type: 'string',
|
|
938
|
-
description: '
|
|
939
|
-
example: 'Assets:
|
|
1139
|
+
description: 'Fully-qualified Beancount account path',
|
|
1140
|
+
example: 'Assets:Checking'
|
|
940
1141
|
},
|
|
941
1142
|
units: {
|
|
942
1143
|
type: 'string',
|
|
@@ -964,6 +1165,15 @@ export const $PostingDetailDto = {
|
|
|
964
1165
|
description: 'Cost date',
|
|
965
1166
|
example: '2024-01-15'
|
|
966
1167
|
},
|
|
1168
|
+
cost: {
|
|
1169
|
+
description:
|
|
1170
|
+
'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
|
|
1171
|
+
allOf: [
|
|
1172
|
+
{
|
|
1173
|
+
$ref: '#/components/schemas/CostDetailDto'
|
|
1174
|
+
}
|
|
1175
|
+
]
|
|
1176
|
+
},
|
|
967
1177
|
priceAmount: {
|
|
968
1178
|
type: 'string',
|
|
969
1179
|
description: 'Price amount',
|
|
@@ -984,7 +1194,7 @@ export const $PostingDetailDto = {
|
|
|
984
1194
|
description: 'Posting metadata'
|
|
985
1195
|
}
|
|
986
1196
|
},
|
|
987
|
-
required: ['id', 'accountId', '
|
|
1197
|
+
required: ['id', 'accountId', 'account']
|
|
988
1198
|
} as const;
|
|
989
1199
|
|
|
990
1200
|
export const $TransactionDetailDto = {
|
|
@@ -1116,6 +1326,77 @@ export const $TransactionDetailDto = {
|
|
|
1116
1326
|
]
|
|
1117
1327
|
} as const;
|
|
1118
1328
|
|
|
1329
|
+
export const $BalanceByCurrencyDto = {
|
|
1330
|
+
type: 'object',
|
|
1331
|
+
properties: {
|
|
1332
|
+
currency: {
|
|
1333
|
+
type: 'string',
|
|
1334
|
+
description: 'ISO 4217 currency code',
|
|
1335
|
+
example: 'CNY'
|
|
1336
|
+
},
|
|
1337
|
+
balance: {
|
|
1338
|
+
type: 'string',
|
|
1339
|
+
description: 'Balance amount',
|
|
1340
|
+
example: '50000.00'
|
|
1341
|
+
}
|
|
1342
|
+
},
|
|
1343
|
+
required: ['currency', 'balance']
|
|
1344
|
+
} as const;
|
|
1345
|
+
|
|
1346
|
+
export const $ExchangeRateWarningDto = {
|
|
1347
|
+
type: 'object',
|
|
1348
|
+
properties: {
|
|
1349
|
+
type: {
|
|
1350
|
+
type: 'string',
|
|
1351
|
+
description: 'Warning type',
|
|
1352
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
1353
|
+
},
|
|
1354
|
+
currency: {
|
|
1355
|
+
type: 'string',
|
|
1356
|
+
description: 'Currency without exchange rate',
|
|
1357
|
+
example: 'EUR'
|
|
1358
|
+
},
|
|
1359
|
+
totalAmount: {
|
|
1360
|
+
type: 'string',
|
|
1361
|
+
description: 'Total amount affected',
|
|
1362
|
+
example: '1000.00'
|
|
1363
|
+
}
|
|
1364
|
+
},
|
|
1365
|
+
required: ['type', 'currency', 'totalAmount']
|
|
1366
|
+
} as const;
|
|
1367
|
+
|
|
1368
|
+
export const $TransactionListSummaryDto = {
|
|
1369
|
+
type: 'object',
|
|
1370
|
+
properties: {
|
|
1371
|
+
totalAmount: {
|
|
1372
|
+
type: 'string',
|
|
1373
|
+
description:
|
|
1374
|
+
'Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.',
|
|
1375
|
+
example: '-6000.00'
|
|
1376
|
+
},
|
|
1377
|
+
currency: {
|
|
1378
|
+
type: 'string',
|
|
1379
|
+
description: 'Base currency (ISO 4217)',
|
|
1380
|
+
example: 'CNY'
|
|
1381
|
+
},
|
|
1382
|
+
balanceByCurrency: {
|
|
1383
|
+
description: 'Raw (unconverted) balance per currency',
|
|
1384
|
+
type: 'array',
|
|
1385
|
+
items: {
|
|
1386
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
1387
|
+
}
|
|
1388
|
+
},
|
|
1389
|
+
warnings: {
|
|
1390
|
+
description: 'Currencies missing an FX rate (omitted when empty)',
|
|
1391
|
+
type: 'array',
|
|
1392
|
+
items: {
|
|
1393
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
1394
|
+
}
|
|
1395
|
+
}
|
|
1396
|
+
},
|
|
1397
|
+
required: ['totalAmount', 'currency', 'balanceByCurrency']
|
|
1398
|
+
} as const;
|
|
1399
|
+
|
|
1119
1400
|
export const $TransactionListResponseDto = {
|
|
1120
1401
|
type: 'object',
|
|
1121
1402
|
properties: {
|
|
@@ -1140,6 +1421,15 @@ export const $TransactionListResponseDto = {
|
|
|
1140
1421
|
type: 'number',
|
|
1141
1422
|
description: 'Number of items skipped',
|
|
1142
1423
|
example: 0
|
|
1424
|
+
},
|
|
1425
|
+
summary: {
|
|
1426
|
+
description:
|
|
1427
|
+
'Amount summary for the full filtered set (#514). Present only when the request has a single account OR category viewpoint; omitted for search-only / plain-list / dual-perspective requests.',
|
|
1428
|
+
allOf: [
|
|
1429
|
+
{
|
|
1430
|
+
$ref: '#/components/schemas/TransactionListSummaryDto'
|
|
1431
|
+
}
|
|
1432
|
+
]
|
|
1143
1433
|
}
|
|
1144
1434
|
},
|
|
1145
1435
|
required: ['data', 'total', 'limit', 'offset']
|
|
@@ -1239,7 +1529,7 @@ export const $BalanceResponseDto = {
|
|
|
1239
1529
|
account: {
|
|
1240
1530
|
type: 'string',
|
|
1241
1531
|
description: 'Account name',
|
|
1242
|
-
example: 'Assets:
|
|
1532
|
+
example: 'Assets:Checking'
|
|
1243
1533
|
},
|
|
1244
1534
|
balance: {
|
|
1245
1535
|
type: 'string',
|
|
@@ -1266,7 +1556,7 @@ export const $MultiCurrencyBalanceResponseDto = {
|
|
|
1266
1556
|
account: {
|
|
1267
1557
|
type: 'string',
|
|
1268
1558
|
description: 'Account name',
|
|
1269
|
-
example: 'Assets:
|
|
1559
|
+
example: 'Assets:Checking'
|
|
1270
1560
|
},
|
|
1271
1561
|
balances: {
|
|
1272
1562
|
type: 'object',
|
|
@@ -1322,7 +1612,7 @@ export const $TransactionSummaryDto = {
|
|
|
1322
1612
|
accountName: {
|
|
1323
1613
|
type: 'string',
|
|
1324
1614
|
description: 'Source account name (first posting)',
|
|
1325
|
-
example: 'Assets:
|
|
1615
|
+
example: 'Assets:Checking'
|
|
1326
1616
|
},
|
|
1327
1617
|
sourceType: {
|
|
1328
1618
|
type: 'string',
|
|
@@ -1724,7 +2014,8 @@ export const $ResolveResultDto = {
|
|
|
1724
2014
|
},
|
|
1725
2015
|
resolutionId: {
|
|
1726
2016
|
type: 'string',
|
|
1727
|
-
description:
|
|
2017
|
+
description:
|
|
2018
|
+
'Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).'
|
|
1728
2019
|
},
|
|
1729
2020
|
canUndo: {
|
|
1730
2021
|
type: 'boolean',
|
|
@@ -1742,7 +2033,7 @@ export const $ResolveResultDto = {
|
|
|
1742
2033
|
example: 'rule_01HXK5V8N2M3P4Q5R6S7T8U9V0'
|
|
1743
2034
|
}
|
|
1744
2035
|
},
|
|
1745
|
-
required: ['success'
|
|
2036
|
+
required: ['success']
|
|
1746
2037
|
} as const;
|
|
1747
2038
|
|
|
1748
2039
|
export const $UndoResultDto = {
|
|
@@ -2613,12 +2904,169 @@ export const $UpdateCommodityDto = {
|
|
|
2613
2904
|
}
|
|
2614
2905
|
} as const;
|
|
2615
2906
|
|
|
2616
|
-
export const $
|
|
2907
|
+
export const $CreateBeanPriceDto = {
|
|
2617
2908
|
type: 'object',
|
|
2618
2909
|
properties: {
|
|
2619
|
-
|
|
2910
|
+
currency: {
|
|
2620
2911
|
type: 'string',
|
|
2621
|
-
description: '
|
|
2912
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
2913
|
+
example: 'USD'
|
|
2914
|
+
},
|
|
2915
|
+
quoteCurrency: {
|
|
2916
|
+
type: 'string',
|
|
2917
|
+
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
2918
|
+
example: 'CNY'
|
|
2919
|
+
},
|
|
2920
|
+
amount: {
|
|
2921
|
+
type: 'number',
|
|
2922
|
+
description:
|
|
2923
|
+
'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
|
|
2924
|
+
example: 175.5,
|
|
2925
|
+
minimum: 0
|
|
2926
|
+
},
|
|
2927
|
+
date: {
|
|
2928
|
+
type: 'string',
|
|
2929
|
+
description: 'Price date (ISO 8601 format)',
|
|
2930
|
+
example: '2024-11-05'
|
|
2931
|
+
},
|
|
2932
|
+
metadata: {
|
|
2933
|
+
type: 'object',
|
|
2934
|
+
description:
|
|
2935
|
+
'Metadata (validated by Zod schema, max field lengths enforced)',
|
|
2936
|
+
example: {
|
|
2937
|
+
source: 'MANUAL',
|
|
2938
|
+
note: 'Bank valuation report',
|
|
2939
|
+
confidence: 0.95
|
|
2940
|
+
}
|
|
2941
|
+
}
|
|
2942
|
+
},
|
|
2943
|
+
required: ['currency', 'quoteCurrency', 'amount', 'date']
|
|
2944
|
+
} as const;
|
|
2945
|
+
|
|
2946
|
+
export const $PriceResponseDto = {
|
|
2947
|
+
type: 'object',
|
|
2948
|
+
properties: {
|
|
2949
|
+
id: {
|
|
2950
|
+
type: 'string',
|
|
2951
|
+
description: 'Unique identifier',
|
|
2952
|
+
example: 'uuid-123-456'
|
|
2953
|
+
},
|
|
2954
|
+
userId: {
|
|
2955
|
+
type: 'string',
|
|
2956
|
+
description: 'User ID (owner of the price)',
|
|
2957
|
+
example: 'user-123'
|
|
2958
|
+
},
|
|
2959
|
+
currency: {
|
|
2960
|
+
type: 'string',
|
|
2961
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
2962
|
+
example: 'BTC'
|
|
2963
|
+
},
|
|
2964
|
+
quoteCurrency: {
|
|
2965
|
+
type: 'string',
|
|
2966
|
+
description: 'Quote currency (pricing currency, e.g., USD, CNY)',
|
|
2967
|
+
example: 'USD'
|
|
2968
|
+
},
|
|
2969
|
+
amount: {
|
|
2970
|
+
type: 'number',
|
|
2971
|
+
description:
|
|
2972
|
+
'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
|
|
2973
|
+
example: 50000
|
|
2974
|
+
},
|
|
2975
|
+
date: {
|
|
2976
|
+
type: 'string',
|
|
2977
|
+
description:
|
|
2978
|
+
'Price date (ISO 8601 format). Represents the date this price was valid.',
|
|
2979
|
+
example: '2024-01-01',
|
|
2980
|
+
format: 'date'
|
|
2981
|
+
},
|
|
2982
|
+
meta: {
|
|
2983
|
+
type: 'object',
|
|
2984
|
+
description:
|
|
2985
|
+
'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
|
|
2986
|
+
example: {
|
|
2987
|
+
source: 'MANUAL',
|
|
2988
|
+
note: 'User-defined price',
|
|
2989
|
+
confidence: 1
|
|
2990
|
+
}
|
|
2991
|
+
},
|
|
2992
|
+
createdAt: {
|
|
2993
|
+
format: 'date-time',
|
|
2994
|
+
type: 'string',
|
|
2995
|
+
description: 'Creation timestamp',
|
|
2996
|
+
example: '2024-11-03T10:00:00Z'
|
|
2997
|
+
},
|
|
2998
|
+
updatedAt: {
|
|
2999
|
+
format: 'date-time',
|
|
3000
|
+
type: 'string',
|
|
3001
|
+
description: 'Last update timestamp',
|
|
3002
|
+
example: '2024-11-03T10:00:00Z'
|
|
3003
|
+
}
|
|
3004
|
+
},
|
|
3005
|
+
required: [
|
|
3006
|
+
'id',
|
|
3007
|
+
'userId',
|
|
3008
|
+
'currency',
|
|
3009
|
+
'quoteCurrency',
|
|
3010
|
+
'amount',
|
|
3011
|
+
'date',
|
|
3012
|
+
'meta',
|
|
3013
|
+
'createdAt',
|
|
3014
|
+
'updatedAt'
|
|
3015
|
+
]
|
|
3016
|
+
} as const;
|
|
3017
|
+
|
|
3018
|
+
export const $PriceListResponseDto = {
|
|
3019
|
+
type: 'object',
|
|
3020
|
+
properties: {
|
|
3021
|
+
items: {
|
|
3022
|
+
description: 'List of prices',
|
|
3023
|
+
type: 'array',
|
|
3024
|
+
items: {
|
|
3025
|
+
$ref: '#/components/schemas/PriceResponseDto'
|
|
3026
|
+
}
|
|
3027
|
+
},
|
|
3028
|
+
total: {
|
|
3029
|
+
type: 'number',
|
|
3030
|
+
description: 'Total number of prices',
|
|
3031
|
+
example: 42
|
|
3032
|
+
}
|
|
3033
|
+
},
|
|
3034
|
+
required: ['items', 'total']
|
|
3035
|
+
} as const;
|
|
3036
|
+
|
|
3037
|
+
export const $UpdateBeanPriceDto = {
|
|
3038
|
+
type: 'object',
|
|
3039
|
+
properties: {
|
|
3040
|
+
currency: {
|
|
3041
|
+
type: 'string',
|
|
3042
|
+
description: 'Currency being priced'
|
|
3043
|
+
},
|
|
3044
|
+
quoteCurrency: {
|
|
3045
|
+
type: 'string',
|
|
3046
|
+
description: 'Quote currency (pricing currency)'
|
|
3047
|
+
},
|
|
3048
|
+
amount: {
|
|
3049
|
+
type: 'number',
|
|
3050
|
+
description: 'Price amount (MUST be >= 0 per Beancount spec)',
|
|
3051
|
+
minimum: 0
|
|
3052
|
+
},
|
|
3053
|
+
date: {
|
|
3054
|
+
type: 'string',
|
|
3055
|
+
description: 'Price date (ISO 8601 format)'
|
|
3056
|
+
},
|
|
3057
|
+
metadata: {
|
|
3058
|
+
type: 'object',
|
|
3059
|
+
description: 'Metadata'
|
|
3060
|
+
}
|
|
3061
|
+
}
|
|
3062
|
+
} as const;
|
|
3063
|
+
|
|
3064
|
+
export const $CreateRecurringRuleDto = {
|
|
3065
|
+
type: 'object',
|
|
3066
|
+
properties: {
|
|
3067
|
+
name: {
|
|
3068
|
+
type: 'string',
|
|
3069
|
+
description: 'Rule name (unique per user)',
|
|
2622
3070
|
maxLength: 100
|
|
2623
3071
|
},
|
|
2624
3072
|
icon: {
|
|
@@ -3384,121 +3832,568 @@ export const $ForecastResponseDto = {
|
|
|
3384
3832
|
]
|
|
3385
3833
|
} as const;
|
|
3386
3834
|
|
|
3387
|
-
export const $
|
|
3835
|
+
export const $CurrencyBalanceDto = {
|
|
3388
3836
|
type: 'object',
|
|
3389
3837
|
properties: {
|
|
3390
|
-
|
|
3838
|
+
currency: {
|
|
3391
3839
|
type: 'string',
|
|
3392
|
-
|
|
3393
|
-
|
|
3840
|
+
description: 'ISO 4217 currency code',
|
|
3841
|
+
example: 'CNY'
|
|
3394
3842
|
},
|
|
3395
|
-
|
|
3843
|
+
balance: {
|
|
3396
3844
|
type: 'string',
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
|
|
3408
|
-
type: 'array'
|
|
3409
|
-
},
|
|
3410
|
-
maxItems: 50,
|
|
3411
|
-
type: 'array'
|
|
3412
|
-
},
|
|
3413
|
-
categoryKeywords: {
|
|
3414
|
-
items: {
|
|
3415
|
-
type: 'array'
|
|
3416
|
-
},
|
|
3417
|
-
maxItems: 50,
|
|
3418
|
-
type: 'array'
|
|
3419
|
-
},
|
|
3420
|
-
methodKeywords: {
|
|
3421
|
-
items: {
|
|
3422
|
-
type: 'array'
|
|
3423
|
-
},
|
|
3424
|
-
maxItems: 50,
|
|
3425
|
-
description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
|
|
3426
|
-
type: 'array'
|
|
3427
|
-
},
|
|
3428
|
-
categoryAccount: {
|
|
3845
|
+
description: 'Balance amount',
|
|
3846
|
+
example: '500000.00'
|
|
3847
|
+
}
|
|
3848
|
+
},
|
|
3849
|
+
required: ['currency', 'balance']
|
|
3850
|
+
} as const;
|
|
3851
|
+
|
|
3852
|
+
export const $TimeSeriesPointDto = {
|
|
3853
|
+
type: 'object',
|
|
3854
|
+
properties: {
|
|
3855
|
+
date: {
|
|
3429
3856
|
type: 'string',
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
|
|
3857
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3858
|
+
example: '2024-06-15'
|
|
3433
3859
|
},
|
|
3434
|
-
|
|
3860
|
+
value: {
|
|
3435
3861
|
type: 'string',
|
|
3436
|
-
|
|
3437
|
-
|
|
3862
|
+
description: 'Value at this date (in base currency)',
|
|
3863
|
+
example: '500000.00'
|
|
3438
3864
|
},
|
|
3439
|
-
|
|
3440
|
-
type: '
|
|
3441
|
-
|
|
3442
|
-
|
|
3865
|
+
change: {
|
|
3866
|
+
type: 'object',
|
|
3867
|
+
description: 'Change from previous point',
|
|
3868
|
+
example: '5000.00'
|
|
3443
3869
|
},
|
|
3444
|
-
|
|
3445
|
-
type: '
|
|
3446
|
-
|
|
3447
|
-
|
|
3870
|
+
assets: {
|
|
3871
|
+
type: 'string',
|
|
3872
|
+
description: 'Total assets at this date (in base currency)',
|
|
3873
|
+
example: '494338.00'
|
|
3448
3874
|
},
|
|
3449
|
-
|
|
3450
|
-
type: '
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
maximum: 1000
|
|
3875
|
+
liabilities: {
|
|
3876
|
+
type: 'string',
|
|
3877
|
+
description: 'Total liabilities at this date (in base currency)',
|
|
3878
|
+
example: '310098.00'
|
|
3454
3879
|
},
|
|
3455
|
-
|
|
3880
|
+
byCurrency: {
|
|
3881
|
+
description: 'Multi-currency breakdown for this point',
|
|
3882
|
+
type: 'array',
|
|
3456
3883
|
items: {
|
|
3457
|
-
|
|
3458
|
-
}
|
|
3459
|
-
maxItems: 20,
|
|
3460
|
-
type: 'array'
|
|
3461
|
-
},
|
|
3462
|
-
additionalMetadata: {
|
|
3463
|
-
type: 'object'
|
|
3464
|
-
},
|
|
3465
|
-
upsertByPayee: {
|
|
3466
|
-
type: 'boolean',
|
|
3467
|
-
description:
|
|
3468
|
-
'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
|
|
3884
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3885
|
+
}
|
|
3469
3886
|
}
|
|
3470
3887
|
},
|
|
3471
|
-
required: ['
|
|
3472
|
-
} as const;
|
|
3473
|
-
|
|
3474
|
-
export const $AmountRangeDto = {
|
|
3475
|
-
type: 'object',
|
|
3476
|
-
properties: {
|
|
3477
|
-
min: {
|
|
3478
|
-
type: 'number',
|
|
3479
|
-
description: 'Minimum amount'
|
|
3480
|
-
},
|
|
3481
|
-
max: {
|
|
3482
|
-
type: 'number',
|
|
3483
|
-
description: 'Maximum amount'
|
|
3484
|
-
}
|
|
3485
|
-
}
|
|
3888
|
+
required: ['date', 'value']
|
|
3486
3889
|
} as const;
|
|
3487
3890
|
|
|
3488
|
-
export const $
|
|
3891
|
+
export const $TrendSummaryDto = {
|
|
3489
3892
|
type: 'object',
|
|
3490
3893
|
properties: {
|
|
3491
|
-
|
|
3894
|
+
startValue: {
|
|
3492
3895
|
type: 'string',
|
|
3493
|
-
description: '
|
|
3896
|
+
description: 'Value at start of period',
|
|
3897
|
+
example: '450000.00'
|
|
3494
3898
|
},
|
|
3495
|
-
|
|
3899
|
+
endValue: {
|
|
3496
3900
|
type: 'string',
|
|
3497
|
-
description: '
|
|
3901
|
+
description: 'Value at end of period',
|
|
3902
|
+
example: '500000.00'
|
|
3498
3903
|
},
|
|
3499
|
-
|
|
3904
|
+
totalChange: {
|
|
3500
3905
|
type: 'string',
|
|
3501
|
-
description: '
|
|
3906
|
+
description: 'Total change over period',
|
|
3907
|
+
example: '50000.00'
|
|
3908
|
+
},
|
|
3909
|
+
totalChangePercentage: {
|
|
3910
|
+
type: 'string',
|
|
3911
|
+
description: 'Total change percentage',
|
|
3912
|
+
example: '+11.11%'
|
|
3913
|
+
}
|
|
3914
|
+
},
|
|
3915
|
+
required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
|
|
3916
|
+
} as const;
|
|
3917
|
+
|
|
3918
|
+
export const $MultiCurrencyPointDto = {
|
|
3919
|
+
type: 'object',
|
|
3920
|
+
properties: {
|
|
3921
|
+
date: {
|
|
3922
|
+
type: 'string',
|
|
3923
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3924
|
+
example: '2024-06-15'
|
|
3925
|
+
},
|
|
3926
|
+
byCurrency: {
|
|
3927
|
+
description: 'Balances by currency',
|
|
3928
|
+
type: 'array',
|
|
3929
|
+
items: {
|
|
3930
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3931
|
+
}
|
|
3932
|
+
}
|
|
3933
|
+
},
|
|
3934
|
+
required: ['date', 'byCurrency']
|
|
3935
|
+
} as const;
|
|
3936
|
+
|
|
3937
|
+
export const $PortfolioTrendsResponseDto = {
|
|
3938
|
+
type: 'object',
|
|
3939
|
+
properties: {
|
|
3940
|
+
series: {
|
|
3941
|
+
description: 'Time series data points',
|
|
3942
|
+
type: 'array',
|
|
3943
|
+
items: {
|
|
3944
|
+
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
3945
|
+
}
|
|
3946
|
+
},
|
|
3947
|
+
summary: {
|
|
3948
|
+
description: 'Period summary',
|
|
3949
|
+
allOf: [
|
|
3950
|
+
{
|
|
3951
|
+
$ref: '#/components/schemas/TrendSummaryDto'
|
|
3952
|
+
}
|
|
3953
|
+
]
|
|
3954
|
+
},
|
|
3955
|
+
period: {
|
|
3956
|
+
type: 'string',
|
|
3957
|
+
description: 'Period requested',
|
|
3958
|
+
example: '6m'
|
|
3959
|
+
},
|
|
3960
|
+
granularity: {
|
|
3961
|
+
type: 'string',
|
|
3962
|
+
description: 'Data granularity',
|
|
3963
|
+
example: 'month'
|
|
3964
|
+
},
|
|
3965
|
+
currency: {
|
|
3966
|
+
type: 'string',
|
|
3967
|
+
description: 'Base currency for converted values',
|
|
3968
|
+
example: 'CNY'
|
|
3969
|
+
},
|
|
3970
|
+
byCurrency: {
|
|
3971
|
+
description:
|
|
3972
|
+
'Multi-currency time series (each point has currency breakdown)',
|
|
3973
|
+
type: 'array',
|
|
3974
|
+
items: {
|
|
3975
|
+
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
3976
|
+
}
|
|
3977
|
+
},
|
|
3978
|
+
warnings: {
|
|
3979
|
+
description: 'Exchange rate warnings',
|
|
3980
|
+
type: 'array',
|
|
3981
|
+
items: {
|
|
3982
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
3983
|
+
}
|
|
3984
|
+
}
|
|
3985
|
+
},
|
|
3986
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
3987
|
+
} as const;
|
|
3988
|
+
|
|
3989
|
+
export const $CashFlowPointDto = {
|
|
3990
|
+
type: 'object',
|
|
3991
|
+
properties: {
|
|
3992
|
+
month: {
|
|
3993
|
+
type: 'string',
|
|
3994
|
+
description: 'Month key (YYYY-MM)',
|
|
3995
|
+
example: '2024-03'
|
|
3996
|
+
},
|
|
3997
|
+
income: {
|
|
3998
|
+
type: 'string',
|
|
3999
|
+
description: 'Income in base currency (absolute, converted)',
|
|
4000
|
+
example: '10000.00'
|
|
4001
|
+
},
|
|
4002
|
+
expense: {
|
|
4003
|
+
type: 'string',
|
|
4004
|
+
description: 'Expense in base currency (absolute, converted)',
|
|
4005
|
+
example: '5000.00'
|
|
4006
|
+
},
|
|
4007
|
+
netSavings: {
|
|
4008
|
+
type: 'string',
|
|
4009
|
+
description: 'netSavings = income − expense (savings positive)',
|
|
4010
|
+
example: '5000.00'
|
|
4011
|
+
}
|
|
4012
|
+
},
|
|
4013
|
+
required: ['month', 'income', 'expense', 'netSavings']
|
|
4014
|
+
} as const;
|
|
4015
|
+
|
|
4016
|
+
export const $CashFlowTrendSummaryDto = {
|
|
4017
|
+
type: 'object',
|
|
4018
|
+
properties: {
|
|
4019
|
+
totalIncome: {
|
|
4020
|
+
type: 'string',
|
|
4021
|
+
description: 'Total income across the period',
|
|
4022
|
+
example: '60000.00'
|
|
4023
|
+
},
|
|
4024
|
+
totalExpense: {
|
|
4025
|
+
type: 'string',
|
|
4026
|
+
description: 'Total expense across the period',
|
|
4027
|
+
example: '30000.00'
|
|
4028
|
+
},
|
|
4029
|
+
totalNetSavings: {
|
|
4030
|
+
type: 'string',
|
|
4031
|
+
description: 'income − expense across the period',
|
|
4032
|
+
example: '30000.00'
|
|
4033
|
+
},
|
|
4034
|
+
averageMonthlyNetSavings: {
|
|
4035
|
+
type: 'string',
|
|
4036
|
+
description:
|
|
4037
|
+
'totalNetSavings divided by the window length (N months, incl. zero-filled)',
|
|
4038
|
+
example: '5000.00'
|
|
4039
|
+
}
|
|
4040
|
+
},
|
|
4041
|
+
required: [
|
|
4042
|
+
'totalIncome',
|
|
4043
|
+
'totalExpense',
|
|
4044
|
+
'totalNetSavings',
|
|
4045
|
+
'averageMonthlyNetSavings'
|
|
4046
|
+
]
|
|
4047
|
+
} as const;
|
|
4048
|
+
|
|
4049
|
+
export const $CashFlowTrendsResponseDto = {
|
|
4050
|
+
type: 'object',
|
|
4051
|
+
properties: {
|
|
4052
|
+
series: {
|
|
4053
|
+
description:
|
|
4054
|
+
'Monthly cash-flow series (fixed N-month window, zero-filled)',
|
|
4055
|
+
type: 'array',
|
|
4056
|
+
items: {
|
|
4057
|
+
$ref: '#/components/schemas/CashFlowPointDto'
|
|
4058
|
+
}
|
|
4059
|
+
},
|
|
4060
|
+
summary: {
|
|
4061
|
+
description: 'Period totals',
|
|
4062
|
+
allOf: [
|
|
4063
|
+
{
|
|
4064
|
+
$ref: '#/components/schemas/CashFlowTrendSummaryDto'
|
|
4065
|
+
}
|
|
4066
|
+
]
|
|
4067
|
+
},
|
|
4068
|
+
period: {
|
|
4069
|
+
type: 'string',
|
|
4070
|
+
description: 'Period requested',
|
|
4071
|
+
example: '6m'
|
|
4072
|
+
},
|
|
4073
|
+
granularity: {
|
|
4074
|
+
type: 'string',
|
|
4075
|
+
description: 'Data granularity (v1 returns month buckets)',
|
|
4076
|
+
example: 'month'
|
|
4077
|
+
},
|
|
4078
|
+
currency: {
|
|
4079
|
+
type: 'string',
|
|
4080
|
+
description: 'Base currency for converted values',
|
|
4081
|
+
example: 'CNY'
|
|
4082
|
+
},
|
|
4083
|
+
warnings: {
|
|
4084
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
4085
|
+
type: 'array',
|
|
4086
|
+
items: {
|
|
4087
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
4088
|
+
}
|
|
4089
|
+
}
|
|
4090
|
+
},
|
|
4091
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
4092
|
+
} as const;
|
|
4093
|
+
|
|
4094
|
+
export const $GenerateSnapshotBody = {
|
|
4095
|
+
type: 'object',
|
|
4096
|
+
properties: {}
|
|
4097
|
+
} as const;
|
|
4098
|
+
|
|
4099
|
+
export const $GenerateSnapshotResponse = {
|
|
4100
|
+
type: 'object',
|
|
4101
|
+
properties: {}
|
|
4102
|
+
} as const;
|
|
4103
|
+
|
|
4104
|
+
export const $BackfillSnapshotsBody = {
|
|
4105
|
+
type: 'object',
|
|
4106
|
+
properties: {}
|
|
4107
|
+
} as const;
|
|
4108
|
+
|
|
4109
|
+
export const $BackfillSnapshotsResponse = {
|
|
4110
|
+
type: 'object',
|
|
4111
|
+
properties: {}
|
|
4112
|
+
} as const;
|
|
4113
|
+
|
|
4114
|
+
export const $DeleteOwnUserDto = {
|
|
4115
|
+
type: 'object',
|
|
4116
|
+
properties: {
|
|
4117
|
+
accessToken: {
|
|
4118
|
+
type: 'string',
|
|
4119
|
+
description: 'Access token for user verification',
|
|
4120
|
+
example: 'abc123xyz'
|
|
4121
|
+
}
|
|
4122
|
+
},
|
|
4123
|
+
required: ['accessToken']
|
|
4124
|
+
} as const;
|
|
4125
|
+
|
|
4126
|
+
export const $SignupDto = {
|
|
4127
|
+
type: 'object',
|
|
4128
|
+
properties: {
|
|
4129
|
+
turnstileToken: {
|
|
4130
|
+
type: 'string',
|
|
4131
|
+
description:
|
|
4132
|
+
'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
|
|
4133
|
+
example: '0.abc123def456...'
|
|
4134
|
+
}
|
|
4135
|
+
}
|
|
4136
|
+
} as const;
|
|
4137
|
+
|
|
4138
|
+
export const $SignupResponseDto = {
|
|
4139
|
+
type: 'object',
|
|
4140
|
+
properties: {
|
|
4141
|
+
authToken: {
|
|
4142
|
+
type: 'string',
|
|
4143
|
+
description: 'JWT auth token',
|
|
4144
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
4145
|
+
},
|
|
4146
|
+
accessToken: {
|
|
4147
|
+
type: 'string',
|
|
4148
|
+
description: 'Auto-generated access token'
|
|
4149
|
+
},
|
|
4150
|
+
role: {
|
|
4151
|
+
type: 'string',
|
|
4152
|
+
description: 'Assigned user role',
|
|
4153
|
+
enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
|
|
4154
|
+
}
|
|
4155
|
+
},
|
|
4156
|
+
required: ['authToken', 'accessToken', 'role']
|
|
4157
|
+
} as const;
|
|
4158
|
+
|
|
4159
|
+
export const $UpdateUserSettingDto = {
|
|
4160
|
+
type: 'object',
|
|
4161
|
+
properties: {
|
|
4162
|
+
secId: {
|
|
4163
|
+
type: 'number',
|
|
4164
|
+
description: 'Security ID'
|
|
4165
|
+
},
|
|
4166
|
+
annualInterestRate: {
|
|
4167
|
+
type: 'number',
|
|
4168
|
+
description: 'Annual interest rate',
|
|
4169
|
+
example: 0.05
|
|
4170
|
+
},
|
|
4171
|
+
currency: {
|
|
4172
|
+
type: 'string',
|
|
4173
|
+
description: 'Currency code',
|
|
4174
|
+
example: 'USD'
|
|
4175
|
+
},
|
|
4176
|
+
baseCurrency: {
|
|
4177
|
+
type: 'string',
|
|
4178
|
+
description: 'Base currency code',
|
|
4179
|
+
example: 'USD'
|
|
4180
|
+
},
|
|
4181
|
+
benchmark: {
|
|
4182
|
+
type: 'string',
|
|
4183
|
+
description: 'Benchmark symbol',
|
|
4184
|
+
example: 'SPY'
|
|
4185
|
+
},
|
|
4186
|
+
colorScheme: {
|
|
4187
|
+
type: 'string',
|
|
4188
|
+
description: 'Color scheme',
|
|
4189
|
+
enum: ['DARK', 'LIGHT']
|
|
4190
|
+
},
|
|
4191
|
+
dateRange: {
|
|
4192
|
+
type: 'string',
|
|
4193
|
+
description: 'Date range filter',
|
|
4194
|
+
example: '1y'
|
|
4195
|
+
},
|
|
4196
|
+
emergencyFund: {
|
|
4197
|
+
type: 'number',
|
|
4198
|
+
description: 'Emergency fund amount',
|
|
4199
|
+
example: 10000
|
|
4200
|
+
},
|
|
4201
|
+
'filters.accounts': {
|
|
4202
|
+
description: 'Account filter IDs',
|
|
4203
|
+
type: 'array',
|
|
4204
|
+
items: {
|
|
4205
|
+
type: 'string'
|
|
4206
|
+
}
|
|
4207
|
+
},
|
|
4208
|
+
'filters.assetClasses': {
|
|
4209
|
+
description: 'Asset class filters',
|
|
4210
|
+
type: 'array',
|
|
4211
|
+
items: {
|
|
4212
|
+
type: 'string'
|
|
4213
|
+
}
|
|
4214
|
+
},
|
|
4215
|
+
'filters.dataSource': {
|
|
4216
|
+
type: 'string',
|
|
4217
|
+
description: 'Data source filter'
|
|
4218
|
+
},
|
|
4219
|
+
'filters.symbol': {
|
|
4220
|
+
type: 'string',
|
|
4221
|
+
description: 'Symbol filter'
|
|
4222
|
+
},
|
|
4223
|
+
'filters.tags': {
|
|
4224
|
+
description: 'Tag filters',
|
|
4225
|
+
type: 'array',
|
|
4226
|
+
items: {
|
|
4227
|
+
type: 'string'
|
|
4228
|
+
}
|
|
4229
|
+
},
|
|
4230
|
+
isExperimentalFeatures: {
|
|
4231
|
+
type: 'boolean',
|
|
4232
|
+
description: 'Enable experimental features'
|
|
4233
|
+
},
|
|
4234
|
+
isRestrictedView: {
|
|
4235
|
+
type: 'boolean',
|
|
4236
|
+
description: 'Enable restricted view mode'
|
|
4237
|
+
},
|
|
4238
|
+
language: {
|
|
4239
|
+
type: 'string',
|
|
4240
|
+
description: 'Language code',
|
|
4241
|
+
example: 'en'
|
|
4242
|
+
},
|
|
4243
|
+
locale: {
|
|
4244
|
+
type: 'string',
|
|
4245
|
+
description: 'Locale code',
|
|
4246
|
+
example: 'en-US'
|
|
4247
|
+
},
|
|
4248
|
+
projectedTotalAmount: {
|
|
4249
|
+
type: 'number',
|
|
4250
|
+
description: 'Projected total amount',
|
|
4251
|
+
example: 1000000
|
|
4252
|
+
},
|
|
4253
|
+
retirementDate: {
|
|
4254
|
+
type: 'string',
|
|
4255
|
+
description: 'Retirement date in ISO 8601 format',
|
|
4256
|
+
example: '2050-01-01'
|
|
4257
|
+
},
|
|
4258
|
+
savingsRate: {
|
|
4259
|
+
type: 'number',
|
|
4260
|
+
description: 'Savings rate percentage',
|
|
4261
|
+
example: 0.2
|
|
4262
|
+
},
|
|
4263
|
+
viewMode: {
|
|
4264
|
+
type: 'string',
|
|
4265
|
+
description: 'View mode',
|
|
4266
|
+
enum: ['DEFAULT', 'ZEN']
|
|
4267
|
+
}
|
|
4268
|
+
}
|
|
4269
|
+
} as const;
|
|
4270
|
+
|
|
4271
|
+
export const $UpdatePropertyDto = {
|
|
4272
|
+
type: 'object',
|
|
4273
|
+
properties: {
|
|
4274
|
+
value: {
|
|
4275
|
+
type: 'string',
|
|
4276
|
+
description: 'Property value'
|
|
4277
|
+
}
|
|
4278
|
+
},
|
|
4279
|
+
required: ['value']
|
|
4280
|
+
} as const;
|
|
4281
|
+
|
|
4282
|
+
export const $CreateTransactionRuleDto = {
|
|
4283
|
+
type: 'object',
|
|
4284
|
+
properties: {
|
|
4285
|
+
name: {
|
|
4286
|
+
type: 'string',
|
|
4287
|
+
minLength: 1,
|
|
4288
|
+
maxLength: 100
|
|
4289
|
+
},
|
|
4290
|
+
description: {
|
|
4291
|
+
type: 'string',
|
|
4292
|
+
maxLength: 500
|
|
4293
|
+
},
|
|
4294
|
+
narrationKeywords: {
|
|
4295
|
+
items: {
|
|
4296
|
+
type: 'array'
|
|
4297
|
+
},
|
|
4298
|
+
maxItems: 50,
|
|
4299
|
+
type: 'array'
|
|
4300
|
+
},
|
|
4301
|
+
payeeKeywords: {
|
|
4302
|
+
items: {
|
|
4303
|
+
type: 'array'
|
|
4304
|
+
},
|
|
4305
|
+
maxItems: 50,
|
|
4306
|
+
type: 'array'
|
|
4307
|
+
},
|
|
4308
|
+
categoryKeywords: {
|
|
4309
|
+
items: {
|
|
4310
|
+
type: 'array'
|
|
4311
|
+
},
|
|
4312
|
+
maxItems: 50,
|
|
4313
|
+
type: 'array'
|
|
4314
|
+
},
|
|
4315
|
+
methodKeywords: {
|
|
4316
|
+
items: {
|
|
4317
|
+
type: 'array'
|
|
4318
|
+
},
|
|
4319
|
+
maxItems: 50,
|
|
4320
|
+
description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
|
|
4321
|
+
type: 'array'
|
|
4322
|
+
},
|
|
4323
|
+
categoryAccount: {
|
|
4324
|
+
type: 'string',
|
|
4325
|
+
maxLength: 200,
|
|
4326
|
+
description:
|
|
4327
|
+
'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
|
|
4328
|
+
},
|
|
4329
|
+
matchLogic: {
|
|
4330
|
+
type: 'string',
|
|
4331
|
+
enum: ['OR', 'AND'],
|
|
4332
|
+
default: 'OR'
|
|
4333
|
+
},
|
|
4334
|
+
amountMin: {
|
|
4335
|
+
type: 'number',
|
|
4336
|
+
minimum: 0,
|
|
4337
|
+
description: 'Minimum transaction amount (inclusive)'
|
|
4338
|
+
},
|
|
4339
|
+
amountMax: {
|
|
4340
|
+
type: 'number',
|
|
4341
|
+
minimum: 0,
|
|
4342
|
+
description: 'Maximum transaction amount (inclusive)'
|
|
4343
|
+
},
|
|
4344
|
+
priority: {
|
|
4345
|
+
type: 'number',
|
|
4346
|
+
default: 50,
|
|
4347
|
+
minimum: 0,
|
|
4348
|
+
maximum: 1000
|
|
4349
|
+
},
|
|
4350
|
+
additionalTags: {
|
|
4351
|
+
items: {
|
|
4352
|
+
type: 'array'
|
|
4353
|
+
},
|
|
4354
|
+
maxItems: 20,
|
|
4355
|
+
type: 'array'
|
|
4356
|
+
},
|
|
4357
|
+
additionalMetadata: {
|
|
4358
|
+
type: 'object'
|
|
4359
|
+
},
|
|
4360
|
+
upsertByPayee: {
|
|
4361
|
+
type: 'boolean',
|
|
4362
|
+
description:
|
|
4363
|
+
'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
|
|
4364
|
+
}
|
|
4365
|
+
},
|
|
4366
|
+
required: ['name', 'matchLogic', 'priority']
|
|
4367
|
+
} as const;
|
|
4368
|
+
|
|
4369
|
+
export const $AmountRangeDto = {
|
|
4370
|
+
type: 'object',
|
|
4371
|
+
properties: {
|
|
4372
|
+
min: {
|
|
4373
|
+
type: 'number',
|
|
4374
|
+
description: 'Minimum amount'
|
|
4375
|
+
},
|
|
4376
|
+
max: {
|
|
4377
|
+
type: 'number',
|
|
4378
|
+
description: 'Maximum amount'
|
|
4379
|
+
}
|
|
4380
|
+
}
|
|
4381
|
+
} as const;
|
|
4382
|
+
|
|
4383
|
+
export const $TransactionRuleResponseDto = {
|
|
4384
|
+
type: 'object',
|
|
4385
|
+
properties: {
|
|
4386
|
+
id: {
|
|
4387
|
+
type: 'string',
|
|
4388
|
+
description: 'Rule ID'
|
|
4389
|
+
},
|
|
4390
|
+
name: {
|
|
4391
|
+
type: 'string',
|
|
4392
|
+
description: 'Rule name'
|
|
4393
|
+
},
|
|
4394
|
+
description: {
|
|
4395
|
+
type: 'string',
|
|
4396
|
+
description: 'Rule description'
|
|
3502
4397
|
},
|
|
3503
4398
|
narrationKeywords: {
|
|
3504
4399
|
description: 'Keywords to match in transaction narration',
|
|
@@ -4033,151 +4928,393 @@ export const $TestRuleResponseDto = {
|
|
|
4033
4928
|
required: ['ruleId', 'matches', 'confidence', 'matchDetails']
|
|
4034
4929
|
} as const;
|
|
4035
4930
|
|
|
4036
|
-
export const $
|
|
4931
|
+
export const $CreateBeanEventDto = {
|
|
4037
4932
|
type: 'object',
|
|
4038
4933
|
properties: {
|
|
4039
|
-
|
|
4934
|
+
date: {
|
|
4040
4935
|
type: 'string',
|
|
4041
|
-
description: '
|
|
4042
|
-
example: '
|
|
4936
|
+
description: 'Life event date (ISO 8601)',
|
|
4937
|
+
example: '2024-03-15'
|
|
4938
|
+
},
|
|
4939
|
+
type: {
|
|
4940
|
+
type: 'string',
|
|
4941
|
+
description:
|
|
4942
|
+
'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
|
|
4943
|
+
example: 'employer'
|
|
4944
|
+
},
|
|
4945
|
+
description: {
|
|
4946
|
+
type: 'string',
|
|
4947
|
+
description:
|
|
4948
|
+
'Life event description. Empty string is a VALID value (distinct from absence).',
|
|
4949
|
+
example: 'Acme Corp'
|
|
4950
|
+
},
|
|
4951
|
+
meta: {
|
|
4952
|
+
type: 'object',
|
|
4953
|
+
description:
|
|
4954
|
+
'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
|
|
4955
|
+
example: {
|
|
4956
|
+
note: 'Promotion'
|
|
4957
|
+
}
|
|
4043
4958
|
}
|
|
4044
4959
|
},
|
|
4045
|
-
required: ['
|
|
4960
|
+
required: ['date', 'type', 'description']
|
|
4046
4961
|
} as const;
|
|
4047
4962
|
|
|
4048
|
-
export const $
|
|
4963
|
+
export const $EventResponseDto = {
|
|
4049
4964
|
type: 'object',
|
|
4050
4965
|
properties: {
|
|
4051
|
-
|
|
4966
|
+
id: {
|
|
4967
|
+
type: 'string',
|
|
4968
|
+
description: 'Unique identifier',
|
|
4969
|
+
example: 'uuid-123-456'
|
|
4970
|
+
},
|
|
4971
|
+
userId: {
|
|
4972
|
+
type: 'string',
|
|
4973
|
+
description: 'User ID (owner of the life event)',
|
|
4974
|
+
example: 'user-123'
|
|
4975
|
+
},
|
|
4976
|
+
date: {
|
|
4977
|
+
type: 'string',
|
|
4978
|
+
description: 'Life event date (ISO 8601 format)',
|
|
4979
|
+
example: '2024-03-15',
|
|
4980
|
+
format: 'date'
|
|
4981
|
+
},
|
|
4982
|
+
type: {
|
|
4052
4983
|
type: 'string',
|
|
4053
4984
|
description:
|
|
4054
|
-
'
|
|
4055
|
-
example: '
|
|
4985
|
+
'Life event type (user-defined, e.g., "employer", "location")',
|
|
4986
|
+
example: 'employer'
|
|
4987
|
+
},
|
|
4988
|
+
description: {
|
|
4989
|
+
type: 'string',
|
|
4990
|
+
description:
|
|
4991
|
+
'Life event description. May be an empty string (a valid value distinct from absence).',
|
|
4992
|
+
example: 'Acme Corp'
|
|
4993
|
+
},
|
|
4994
|
+
meta: {
|
|
4995
|
+
type: 'object',
|
|
4996
|
+
description: 'Product-side metadata (free-form JSON)',
|
|
4997
|
+
example: {
|
|
4998
|
+
note: 'Promotion'
|
|
4999
|
+
}
|
|
5000
|
+
},
|
|
5001
|
+
createdAt: {
|
|
5002
|
+
format: 'date-time',
|
|
5003
|
+
type: 'string',
|
|
5004
|
+
description: 'Creation timestamp',
|
|
5005
|
+
example: '2024-03-15T10:00:00Z'
|
|
5006
|
+
},
|
|
5007
|
+
updatedAt: {
|
|
5008
|
+
format: 'date-time',
|
|
5009
|
+
type: 'string',
|
|
5010
|
+
description:
|
|
5011
|
+
'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
|
|
5012
|
+
example: '2024-03-15T10:00:00Z'
|
|
4056
5013
|
}
|
|
4057
|
-
}
|
|
5014
|
+
},
|
|
5015
|
+
required: [
|
|
5016
|
+
'id',
|
|
5017
|
+
'userId',
|
|
5018
|
+
'date',
|
|
5019
|
+
'type',
|
|
5020
|
+
'description',
|
|
5021
|
+
'meta',
|
|
5022
|
+
'createdAt',
|
|
5023
|
+
'updatedAt'
|
|
5024
|
+
]
|
|
4058
5025
|
} as const;
|
|
4059
5026
|
|
|
4060
|
-
export const $
|
|
5027
|
+
export const $EventListResponseDto = {
|
|
4061
5028
|
type: 'object',
|
|
4062
5029
|
properties: {
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
|
|
5030
|
+
items: {
|
|
5031
|
+
description: 'List of life events',
|
|
5032
|
+
type: 'array',
|
|
5033
|
+
items: {
|
|
5034
|
+
$ref: '#/components/schemas/EventResponseDto'
|
|
5035
|
+
}
|
|
4066
5036
|
},
|
|
4067
|
-
|
|
5037
|
+
total: {
|
|
4068
5038
|
type: 'number',
|
|
4069
|
-
description: '
|
|
4070
|
-
example:
|
|
5039
|
+
description: 'Total number of life events matching the query',
|
|
5040
|
+
example: 42
|
|
5041
|
+
}
|
|
5042
|
+
},
|
|
5043
|
+
required: ['items', 'total']
|
|
5044
|
+
} as const;
|
|
5045
|
+
|
|
5046
|
+
export const $UpdateBeanEventDto = {
|
|
5047
|
+
type: 'object',
|
|
5048
|
+
properties: {
|
|
5049
|
+
date: {
|
|
5050
|
+
type: 'string',
|
|
5051
|
+
description: 'Life event date (ISO 8601)'
|
|
5052
|
+
},
|
|
5053
|
+
type: {
|
|
5054
|
+
type: 'string',
|
|
5055
|
+
description: 'Life event type (user-defined)'
|
|
5056
|
+
},
|
|
5057
|
+
description: {
|
|
5058
|
+
type: 'string',
|
|
5059
|
+
description:
|
|
5060
|
+
'Life event description. Empty string is a VALID value (distinct from absence).'
|
|
5061
|
+
},
|
|
5062
|
+
meta: {
|
|
5063
|
+
type: 'object',
|
|
5064
|
+
description: 'Product-side metadata (free-form JSON)'
|
|
5065
|
+
}
|
|
5066
|
+
}
|
|
5067
|
+
} as const;
|
|
5068
|
+
|
|
5069
|
+
export const $OnboardingAccountDto = {
|
|
5070
|
+
type: 'object',
|
|
5071
|
+
properties: {
|
|
5072
|
+
path: {
|
|
5073
|
+
type: 'string',
|
|
5074
|
+
description:
|
|
5075
|
+
'Account path (Assets/Liabilities only; format validated by the account service)',
|
|
5076
|
+
example: 'Assets:Checking'
|
|
4071
5077
|
},
|
|
4072
5078
|
currency: {
|
|
4073
5079
|
type: 'string',
|
|
4074
|
-
description: '
|
|
5080
|
+
description: 'ISO 4217 currency code (3 letters)',
|
|
4075
5081
|
example: 'USD'
|
|
4076
5082
|
},
|
|
4077
|
-
|
|
5083
|
+
openingBalance: {
|
|
4078
5084
|
type: 'string',
|
|
4079
|
-
description:
|
|
4080
|
-
|
|
5085
|
+
description:
|
|
5086
|
+
'Opening balance as a non-negative Decimal string (e.g. "1000.00")',
|
|
5087
|
+
example: '1000.00'
|
|
4081
5088
|
},
|
|
4082
|
-
|
|
5089
|
+
platformId: {
|
|
4083
5090
|
type: 'string',
|
|
4084
|
-
description:
|
|
4085
|
-
|
|
5091
|
+
description:
|
|
5092
|
+
'Platform ID to bind the account to (references Platform.id); omit for unbound',
|
|
5093
|
+
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
5094
|
+
}
|
|
5095
|
+
},
|
|
5096
|
+
required: ['path', 'currency']
|
|
5097
|
+
} as const;
|
|
5098
|
+
|
|
5099
|
+
export const $OnboardingDto = {
|
|
5100
|
+
type: 'object',
|
|
5101
|
+
properties: {
|
|
5102
|
+
accounts: {
|
|
5103
|
+
description: 'Asset/Liability accounts to register with opening balances',
|
|
5104
|
+
type: 'array',
|
|
5105
|
+
items: {
|
|
5106
|
+
$ref: '#/components/schemas/OnboardingAccountDto'
|
|
5107
|
+
}
|
|
4086
5108
|
},
|
|
4087
|
-
|
|
5109
|
+
skipAssetRegistration: {
|
|
5110
|
+
type: 'boolean',
|
|
5111
|
+
description:
|
|
5112
|
+
'Skip asset registration; only bootstrap the core account set',
|
|
5113
|
+
default: false
|
|
5114
|
+
}
|
|
5115
|
+
}
|
|
5116
|
+
} as const;
|
|
5117
|
+
|
|
5118
|
+
export const $ActualBalanceDto = {
|
|
5119
|
+
type: 'object',
|
|
5120
|
+
properties: {
|
|
5121
|
+
amount: {
|
|
4088
5122
|
type: 'string',
|
|
4089
|
-
description:
|
|
4090
|
-
|
|
5123
|
+
description:
|
|
5124
|
+
'Actual balance amount as a decimal string (preserves precision for tolerance inference).',
|
|
5125
|
+
example: '1234.56'
|
|
5126
|
+
},
|
|
5127
|
+
ccy: {
|
|
5128
|
+
type: 'string',
|
|
5129
|
+
description: 'Currency code (ISO 4217 or commodity ticker).',
|
|
5130
|
+
example: 'CNY'
|
|
5131
|
+
}
|
|
5132
|
+
},
|
|
5133
|
+
required: ['amount', 'ccy']
|
|
5134
|
+
} as const;
|
|
5135
|
+
|
|
5136
|
+
export const $ComputeReconciliationDto = {
|
|
5137
|
+
type: 'object',
|
|
5138
|
+
properties: {
|
|
5139
|
+
accountId: {
|
|
5140
|
+
type: 'string',
|
|
5141
|
+
description: 'BeanAccount id to reconcile.'
|
|
5142
|
+
},
|
|
5143
|
+
asOfDate: {
|
|
5144
|
+
type: 'string',
|
|
5145
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5146
|
+
example: '2026-07-24'
|
|
5147
|
+
},
|
|
5148
|
+
actualBalance: {
|
|
5149
|
+
description: 'Actual balance from the external statement.',
|
|
5150
|
+
allOf: [
|
|
5151
|
+
{
|
|
5152
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5153
|
+
}
|
|
5154
|
+
]
|
|
5155
|
+
}
|
|
5156
|
+
},
|
|
5157
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5158
|
+
} as const;
|
|
5159
|
+
|
|
5160
|
+
export const $ReconciliationComputeResultDto = {
|
|
5161
|
+
type: 'object',
|
|
5162
|
+
properties: {
|
|
5163
|
+
accountId: {
|
|
5164
|
+
type: 'string'
|
|
5165
|
+
},
|
|
5166
|
+
asOfDate: {
|
|
5167
|
+
type: 'string'
|
|
5168
|
+
},
|
|
5169
|
+
bookBalance: {
|
|
5170
|
+
type: 'string',
|
|
5171
|
+
description: 'System-computed book balance (decimal string).'
|
|
5172
|
+
},
|
|
5173
|
+
actualBalance: {
|
|
5174
|
+
type: 'string',
|
|
5175
|
+
description: 'User-entered actual balance (decimal string).'
|
|
5176
|
+
},
|
|
5177
|
+
currency: {
|
|
5178
|
+
type: 'string'
|
|
4091
5179
|
},
|
|
4092
|
-
|
|
5180
|
+
diff: {
|
|
4093
5181
|
type: 'string',
|
|
4094
|
-
description: '
|
|
4095
|
-
example: '1y'
|
|
4096
|
-
},
|
|
4097
|
-
emergencyFund: {
|
|
4098
|
-
type: 'number',
|
|
4099
|
-
description: 'Emergency fund amount',
|
|
4100
|
-
example: 10000
|
|
5182
|
+
description: 'Diff = book − actual (decimal string).'
|
|
4101
5183
|
},
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
|
|
4105
|
-
items: {
|
|
4106
|
-
type: 'string'
|
|
4107
|
-
}
|
|
5184
|
+
tolerance: {
|
|
5185
|
+
type: 'string',
|
|
5186
|
+
description: 'Applied tolerance (decimal string).'
|
|
4108
5187
|
},
|
|
4109
|
-
|
|
4110
|
-
|
|
4111
|
-
|
|
4112
|
-
items: {
|
|
4113
|
-
type: 'string'
|
|
4114
|
-
}
|
|
5188
|
+
withinTolerance: {
|
|
5189
|
+
type: 'boolean',
|
|
5190
|
+
description: 'true when |diff| ≤ tolerance.'
|
|
4115
5191
|
},
|
|
4116
|
-
|
|
5192
|
+
suggestedAction: {
|
|
4117
5193
|
type: 'string',
|
|
4118
|
-
|
|
5194
|
+
enum: ['assert', 'pad'],
|
|
5195
|
+
description:
|
|
5196
|
+
'Suggested next action: assert when within tolerance, pad otherwise.'
|
|
5197
|
+
}
|
|
5198
|
+
},
|
|
5199
|
+
required: [
|
|
5200
|
+
'accountId',
|
|
5201
|
+
'asOfDate',
|
|
5202
|
+
'bookBalance',
|
|
5203
|
+
'actualBalance',
|
|
5204
|
+
'currency',
|
|
5205
|
+
'diff',
|
|
5206
|
+
'tolerance',
|
|
5207
|
+
'withinTolerance',
|
|
5208
|
+
'suggestedAction'
|
|
5209
|
+
]
|
|
5210
|
+
} as const;
|
|
5211
|
+
|
|
5212
|
+
export const $AssertReconciliationDto = {
|
|
5213
|
+
type: 'object',
|
|
5214
|
+
properties: {
|
|
5215
|
+
accountId: {
|
|
5216
|
+
type: 'string',
|
|
5217
|
+
description: 'BeanAccount id to reconcile.'
|
|
4119
5218
|
},
|
|
4120
|
-
|
|
5219
|
+
asOfDate: {
|
|
4121
5220
|
type: 'string',
|
|
4122
|
-
description: '
|
|
5221
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5222
|
+
example: '2026-07-24'
|
|
4123
5223
|
},
|
|
4124
|
-
|
|
4125
|
-
description: '
|
|
4126
|
-
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
|
|
5224
|
+
actualBalance: {
|
|
5225
|
+
description: 'Actual balance from the external statement.',
|
|
5226
|
+
allOf: [
|
|
5227
|
+
{
|
|
5228
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5229
|
+
}
|
|
5230
|
+
]
|
|
4130
5231
|
},
|
|
4131
|
-
|
|
4132
|
-
type: '
|
|
4133
|
-
description:
|
|
5232
|
+
tolerance: {
|
|
5233
|
+
type: 'string',
|
|
5234
|
+
description:
|
|
5235
|
+
'Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).',
|
|
5236
|
+
example: '0.01'
|
|
5237
|
+
}
|
|
5238
|
+
},
|
|
5239
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5240
|
+
} as const;
|
|
5241
|
+
|
|
5242
|
+
export const $ReconciliationRecordDto = {
|
|
5243
|
+
type: 'object',
|
|
5244
|
+
properties: {
|
|
5245
|
+
id: {
|
|
5246
|
+
type: 'string'
|
|
4134
5247
|
},
|
|
4135
|
-
|
|
4136
|
-
type: '
|
|
4137
|
-
description: 'Enable restricted view mode'
|
|
5248
|
+
accountId: {
|
|
5249
|
+
type: 'string'
|
|
4138
5250
|
},
|
|
4139
|
-
|
|
5251
|
+
date: {
|
|
5252
|
+
type: 'string'
|
|
5253
|
+
},
|
|
5254
|
+
amount: {
|
|
4140
5255
|
type: 'string',
|
|
4141
|
-
description: '
|
|
4142
|
-
example: 'en'
|
|
5256
|
+
description: 'Asserted (actual) amount.'
|
|
4143
5257
|
},
|
|
4144
|
-
|
|
5258
|
+
currency: {
|
|
5259
|
+
type: 'string'
|
|
5260
|
+
},
|
|
5261
|
+
tolerance: {
|
|
5262
|
+
type: 'string'
|
|
5263
|
+
},
|
|
5264
|
+
diffAmount: {
|
|
4145
5265
|
type: 'string',
|
|
4146
|
-
description: '
|
|
4147
|
-
example: 'en-US'
|
|
5266
|
+
description: 'book − actual.'
|
|
4148
5267
|
},
|
|
4149
|
-
|
|
4150
|
-
type: '
|
|
4151
|
-
description: 'Projected total amount',
|
|
4152
|
-
example: 1000000
|
|
5268
|
+
diffCurrency: {
|
|
5269
|
+
type: 'string'
|
|
4153
5270
|
},
|
|
4154
|
-
|
|
5271
|
+
createdAt: {
|
|
5272
|
+
type: 'string'
|
|
5273
|
+
}
|
|
5274
|
+
},
|
|
5275
|
+
required: ['id', 'accountId', 'date', 'amount', 'currency', 'createdAt']
|
|
5276
|
+
} as const;
|
|
5277
|
+
|
|
5278
|
+
export const $PadReconciliationDto = {
|
|
5279
|
+
type: 'object',
|
|
5280
|
+
properties: {
|
|
5281
|
+
accountId: {
|
|
4155
5282
|
type: 'string',
|
|
4156
|
-
description: '
|
|
4157
|
-
example: '2050-01-01'
|
|
5283
|
+
description: 'BeanAccount id to reconcile.'
|
|
4158
5284
|
},
|
|
4159
|
-
|
|
4160
|
-
type: '
|
|
4161
|
-
description: '
|
|
4162
|
-
example:
|
|
5285
|
+
asOfDate: {
|
|
5286
|
+
type: 'string',
|
|
5287
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5288
|
+
example: '2026-07-24'
|
|
4163
5289
|
},
|
|
4164
|
-
|
|
5290
|
+
actualBalance: {
|
|
5291
|
+
description: 'Actual balance from the external statement.',
|
|
5292
|
+
allOf: [
|
|
5293
|
+
{
|
|
5294
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5295
|
+
}
|
|
5296
|
+
]
|
|
5297
|
+
},
|
|
5298
|
+
sourceAccount: {
|
|
4165
5299
|
type: 'string',
|
|
4166
|
-
description:
|
|
4167
|
-
|
|
5300
|
+
description:
|
|
5301
|
+
'Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).',
|
|
5302
|
+
example: 'Equity:Opening-Balances',
|
|
5303
|
+
default: 'Equity:Opening-Balances'
|
|
4168
5304
|
}
|
|
4169
|
-
}
|
|
5305
|
+
},
|
|
5306
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
4170
5307
|
} as const;
|
|
4171
5308
|
|
|
4172
|
-
export const $
|
|
5309
|
+
export const $PadResultDto = {
|
|
4173
5310
|
type: 'object',
|
|
4174
5311
|
properties: {
|
|
4175
|
-
|
|
5312
|
+
transactionId: {
|
|
4176
5313
|
type: 'string',
|
|
4177
|
-
description: '
|
|
5314
|
+
description: 'Created pad adjusting transaction id.'
|
|
4178
5315
|
}
|
|
4179
5316
|
},
|
|
4180
|
-
required: ['
|
|
5317
|
+
required: ['transactionId']
|
|
4181
5318
|
} as const;
|
|
4182
5319
|
|
|
4183
5320
|
export const $FileImportDto = {
|
|
@@ -4346,7 +5483,7 @@ export const $IdentifyResultDto = {
|
|
|
4346
5483
|
account: {
|
|
4347
5484
|
type: 'string',
|
|
4348
5485
|
description: 'Default account used by this importer',
|
|
4349
|
-
example: 'Assets:Alipay:Balance'
|
|
5486
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4350
5487
|
},
|
|
4351
5488
|
message: {
|
|
4352
5489
|
type: 'string',
|
|
@@ -4363,7 +5500,7 @@ export const $MapperDefaultsDto = {
|
|
|
4363
5500
|
sourceAccount: {
|
|
4364
5501
|
type: 'string',
|
|
4365
5502
|
description: 'Source account for transactions (Beancount format)',
|
|
4366
|
-
example: 'Assets:Alipay:Balance'
|
|
5503
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4367
5504
|
},
|
|
4368
5505
|
currency: {
|
|
4369
5506
|
type: 'string',
|
|
@@ -4400,7 +5537,7 @@ export const $MapperDefaultsDto = {
|
|
|
4400
5537
|
description:
|
|
4401
5538
|
'Payment method to source account mapping. Maps payment method keywords to Beancount account paths. Used by Alipay/WeChat importers to determine sourceAccount based on payment method (e.g., HuaBei, CreditCard).',
|
|
4402
5539
|
example: {
|
|
4403
|
-
HuaBei: 'Liabilities:
|
|
5540
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4404
5541
|
CreditCard: 'Liabilities:CreditCard'
|
|
4405
5542
|
}
|
|
4406
5543
|
}
|
|
@@ -4532,8 +5669,9 @@ export const $UpdateMapperDefaultsDto = {
|
|
|
4532
5669
|
sourceAccount: {
|
|
4533
5670
|
type: 'string',
|
|
4534
5671
|
description: 'Source account for transactions (Beancount format)',
|
|
4535
|
-
example: 'Assets:Alipay:Balance',
|
|
4536
|
-
pattern:
|
|
5672
|
+
example: 'Assets:CN:Alipay:Balance',
|
|
5673
|
+
pattern:
|
|
5674
|
+
'^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
|
|
4537
5675
|
},
|
|
4538
5676
|
currency: {
|
|
4539
5677
|
type: 'string',
|
|
@@ -4547,20 +5685,22 @@ export const $UpdateMapperDefaultsDto = {
|
|
|
4547
5685
|
type: 'string',
|
|
4548
5686
|
description: 'Default expense account (optional)',
|
|
4549
5687
|
example: 'Expenses:Unknown',
|
|
4550
|
-
pattern:
|
|
5688
|
+
pattern:
|
|
5689
|
+
'^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
|
|
4551
5690
|
},
|
|
4552
5691
|
incomeAccount: {
|
|
4553
5692
|
type: 'string',
|
|
4554
5693
|
description: 'Default income account (optional)',
|
|
4555
5694
|
example: 'Income:Unknown',
|
|
4556
|
-
pattern:
|
|
5695
|
+
pattern:
|
|
5696
|
+
'^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
|
|
4557
5697
|
},
|
|
4558
5698
|
methodAccountMapping: {
|
|
4559
5699
|
type: 'object',
|
|
4560
5700
|
description:
|
|
4561
5701
|
'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).',
|
|
4562
5702
|
example: {
|
|
4563
|
-
HuaBei: 'Liabilities:
|
|
5703
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4564
5704
|
CreditCard: 'Liabilities:CreditCard'
|
|
4565
5705
|
}
|
|
4566
5706
|
}
|
|
@@ -4595,119 +5735,13 @@ export const $UpdateImporterConfigDto = {
|
|
|
4595
5735
|
}
|
|
4596
5736
|
} as const;
|
|
4597
5737
|
|
|
4598
|
-
export const $CreatePlatformDto = {
|
|
4599
|
-
type: 'object',
|
|
4600
|
-
properties: {
|
|
4601
|
-
name: {
|
|
4602
|
-
type: 'string',
|
|
4603
|
-
description: 'Platform name',
|
|
4604
|
-
example: 'Binance'
|
|
4605
|
-
},
|
|
4606
|
-
canonical: {
|
|
4607
|
-
type: 'string',
|
|
4608
|
-
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
4609
|
-
example: 'binance'
|
|
4610
|
-
},
|
|
4611
|
-
aliases: {
|
|
4612
|
-
description: 'Platform aliases (multi-language names for lookup)',
|
|
4613
|
-
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
4614
|
-
type: 'array',
|
|
4615
|
-
items: {
|
|
4616
|
-
type: 'string'
|
|
4617
|
-
}
|
|
4618
|
-
},
|
|
4619
|
-
url: {
|
|
4620
|
-
type: 'string',
|
|
4621
|
-
description: 'Platform URL',
|
|
4622
|
-
example: 'https://www.binance.com'
|
|
4623
|
-
},
|
|
4624
|
-
type: {
|
|
4625
|
-
type: 'string',
|
|
4626
|
-
description: 'Platform type',
|
|
4627
|
-
enum: [
|
|
4628
|
-
'BANK',
|
|
4629
|
-
'BROKERAGE',
|
|
4630
|
-
'CRYPTO_EXCHANGE',
|
|
4631
|
-
'PAYMENT',
|
|
4632
|
-
'INVESTMENT',
|
|
4633
|
-
'INSURANCE',
|
|
4634
|
-
'OTHER'
|
|
4635
|
-
],
|
|
4636
|
-
example: 'CRYPTO_EXCHANGE'
|
|
4637
|
-
},
|
|
4638
|
-
logoUrl: {
|
|
4639
|
-
type: 'string',
|
|
4640
|
-
description: 'Platform logo URL',
|
|
4641
|
-
example: 'https://example.com/logos/binance.png'
|
|
4642
|
-
},
|
|
4643
|
-
isActive: {
|
|
4644
|
-
type: 'boolean',
|
|
4645
|
-
description: 'Whether the platform is active',
|
|
4646
|
-
default: true
|
|
4647
|
-
}
|
|
4648
|
-
},
|
|
4649
|
-
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
4650
|
-
} as const;
|
|
4651
|
-
|
|
4652
|
-
export const $UpdatePlatformDto = {
|
|
4653
|
-
type: 'object',
|
|
4654
|
-
properties: {
|
|
4655
|
-
name: {
|
|
4656
|
-
type: 'string',
|
|
4657
|
-
description: 'Platform name',
|
|
4658
|
-
example: 'Binance'
|
|
4659
|
-
},
|
|
4660
|
-
canonical: {
|
|
4661
|
-
type: 'string',
|
|
4662
|
-
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
4663
|
-
example: 'binance'
|
|
4664
|
-
},
|
|
4665
|
-
aliases: {
|
|
4666
|
-
description: 'Platform aliases (multi-language names for lookup)',
|
|
4667
|
-
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
4668
|
-
type: 'array',
|
|
4669
|
-
items: {
|
|
4670
|
-
type: 'string'
|
|
4671
|
-
}
|
|
4672
|
-
},
|
|
4673
|
-
url: {
|
|
4674
|
-
type: 'string',
|
|
4675
|
-
description: 'Platform URL',
|
|
4676
|
-
example: 'https://www.binance.com'
|
|
4677
|
-
},
|
|
4678
|
-
type: {
|
|
4679
|
-
type: 'string',
|
|
4680
|
-
description: 'Platform type',
|
|
4681
|
-
enum: [
|
|
4682
|
-
'BANK',
|
|
4683
|
-
'BROKERAGE',
|
|
4684
|
-
'CRYPTO_EXCHANGE',
|
|
4685
|
-
'PAYMENT',
|
|
4686
|
-
'INVESTMENT',
|
|
4687
|
-
'INSURANCE',
|
|
4688
|
-
'OTHER'
|
|
4689
|
-
],
|
|
4690
|
-
example: 'CRYPTO_EXCHANGE'
|
|
4691
|
-
},
|
|
4692
|
-
logoUrl: {
|
|
4693
|
-
type: 'string',
|
|
4694
|
-
description: 'Platform logo URL',
|
|
4695
|
-
example: 'https://example.com/logos/binance.png'
|
|
4696
|
-
},
|
|
4697
|
-
isActive: {
|
|
4698
|
-
type: 'boolean',
|
|
4699
|
-
description: 'Whether the platform is active'
|
|
4700
|
-
}
|
|
4701
|
-
}
|
|
4702
|
-
} as const;
|
|
4703
|
-
|
|
4704
5738
|
export const $ProviderSyncConfigDto = {
|
|
4705
5739
|
type: 'object',
|
|
4706
5740
|
properties: {
|
|
4707
5741
|
sourceAccount: {
|
|
4708
5742
|
type: 'string',
|
|
4709
5743
|
description: 'Source account for the first posting',
|
|
4710
|
-
example: 'Assets:
|
|
5744
|
+
example: 'Assets:US:Chase:Checking'
|
|
4711
5745
|
},
|
|
4712
5746
|
defaultCurrency: {
|
|
4713
5747
|
type: 'string',
|
|
@@ -4716,26 +5750,29 @@ export const $ProviderSyncConfigDto = {
|
|
|
4716
5750
|
},
|
|
4717
5751
|
defaultExpenseAccount: {
|
|
4718
5752
|
type: 'string',
|
|
4719
|
-
description:
|
|
5753
|
+
description:
|
|
5754
|
+
'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
|
|
4720
5755
|
example: 'Expenses:Unknown'
|
|
4721
5756
|
},
|
|
4722
5757
|
defaultIncomeAccount: {
|
|
4723
5758
|
type: 'string',
|
|
4724
|
-
description:
|
|
5759
|
+
description:
|
|
5760
|
+
'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
|
|
4725
5761
|
example: 'Income:Unknown'
|
|
4726
5762
|
},
|
|
4727
5763
|
filterPending: {
|
|
4728
5764
|
type: 'boolean',
|
|
4729
5765
|
description: 'Filter pending transactions',
|
|
4730
5766
|
default: true
|
|
5767
|
+
},
|
|
5768
|
+
externalAccountId: {
|
|
5769
|
+
type: 'string',
|
|
5770
|
+
description:
|
|
5771
|
+
'External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.',
|
|
5772
|
+
example: 'acc_gocardless_001'
|
|
4731
5773
|
}
|
|
4732
5774
|
},
|
|
4733
|
-
required: [
|
|
4734
|
-
'sourceAccount',
|
|
4735
|
-
'defaultCurrency',
|
|
4736
|
-
'defaultExpenseAccount',
|
|
4737
|
-
'defaultIncomeAccount'
|
|
4738
|
-
]
|
|
5775
|
+
required: ['sourceAccount', 'defaultCurrency']
|
|
4739
5776
|
} as const;
|
|
4740
5777
|
|
|
4741
5778
|
export const $ProviderSyncDto = {
|
|
@@ -4840,11 +5877,99 @@ export const $SupportedProvidersResponseDto = {
|
|
|
4840
5877
|
],
|
|
4841
5878
|
type: 'array',
|
|
4842
5879
|
items: {
|
|
4843
|
-
type: 'string'
|
|
5880
|
+
type: 'string'
|
|
5881
|
+
}
|
|
5882
|
+
}
|
|
5883
|
+
},
|
|
5884
|
+
required: ['providers']
|
|
5885
|
+
} as const;
|
|
5886
|
+
|
|
5887
|
+
export const $CreateExternalAccountLinkDto = {
|
|
5888
|
+
type: 'object',
|
|
5889
|
+
properties: {
|
|
5890
|
+
provider: {
|
|
5891
|
+
type: 'string',
|
|
5892
|
+
enum: [
|
|
5893
|
+
'plaid',
|
|
5894
|
+
'teller',
|
|
5895
|
+
'truelayer',
|
|
5896
|
+
'gocardless',
|
|
5897
|
+
'simplefin',
|
|
5898
|
+
'yodlee',
|
|
5899
|
+
'beancount-direct',
|
|
5900
|
+
'parsed-bill'
|
|
5901
|
+
],
|
|
5902
|
+
example: 'plaid',
|
|
5903
|
+
description: 'Open Banking provider (whitelist)'
|
|
5904
|
+
},
|
|
5905
|
+
externalAccountId: {
|
|
5906
|
+
type: 'string',
|
|
5907
|
+
example: 'acc-plaid-001',
|
|
5908
|
+
description: 'External account ID from the provider'
|
|
5909
|
+
},
|
|
5910
|
+
beanAccountId: {
|
|
5911
|
+
type: 'string',
|
|
5912
|
+
example: '550e8400-e29b-41d4-a716-446655440000',
|
|
5913
|
+
description: 'Target BeanAccount ID (must belong to the JWT user)'
|
|
5914
|
+
}
|
|
5915
|
+
},
|
|
5916
|
+
required: ['provider', 'externalAccountId', 'beanAccountId']
|
|
5917
|
+
} as const;
|
|
5918
|
+
|
|
5919
|
+
export const $ExternalAccountLinkResponseDto = {
|
|
5920
|
+
type: 'object',
|
|
5921
|
+
properties: {
|
|
5922
|
+
id: {
|
|
5923
|
+
type: 'string'
|
|
5924
|
+
},
|
|
5925
|
+
provider: {
|
|
5926
|
+
type: 'string'
|
|
5927
|
+
},
|
|
5928
|
+
externalAccountId: {
|
|
5929
|
+
type: 'string'
|
|
5930
|
+
},
|
|
5931
|
+
beanAccountId: {
|
|
5932
|
+
type: 'string'
|
|
5933
|
+
},
|
|
5934
|
+
isActive: {
|
|
5935
|
+
type: 'boolean'
|
|
5936
|
+
},
|
|
5937
|
+
createdAt: {
|
|
5938
|
+
type: 'string'
|
|
5939
|
+
},
|
|
5940
|
+
updatedAt: {
|
|
5941
|
+
type: 'string'
|
|
5942
|
+
}
|
|
5943
|
+
},
|
|
5944
|
+
required: [
|
|
5945
|
+
'id',
|
|
5946
|
+
'provider',
|
|
5947
|
+
'externalAccountId',
|
|
5948
|
+
'beanAccountId',
|
|
5949
|
+
'isActive',
|
|
5950
|
+
'createdAt',
|
|
5951
|
+
'updatedAt'
|
|
5952
|
+
]
|
|
5953
|
+
} as const;
|
|
5954
|
+
|
|
5955
|
+
export const $ExternalAccountLinkListResponseDto = {
|
|
5956
|
+
type: 'object',
|
|
5957
|
+
properties: {
|
|
5958
|
+
items: {
|
|
5959
|
+
type: 'array',
|
|
5960
|
+
items: {
|
|
5961
|
+
$ref: '#/components/schemas/ExternalAccountLinkResponseDto'
|
|
4844
5962
|
}
|
|
5963
|
+
},
|
|
5964
|
+
total: {
|
|
5965
|
+
type: 'number'
|
|
5966
|
+
},
|
|
5967
|
+
provider: {
|
|
5968
|
+
type: 'string',
|
|
5969
|
+
description: 'Filter by provider (query param)'
|
|
4845
5970
|
}
|
|
4846
5971
|
},
|
|
4847
|
-
required: ['
|
|
5972
|
+
required: ['items', 'total']
|
|
4848
5973
|
} as const;
|
|
4849
5974
|
|
|
4850
5975
|
export const $ParserTelemetryReportDto = {
|
|
@@ -4852,15 +5977,27 @@ export const $ParserTelemetryReportDto = {
|
|
|
4852
5977
|
properties: {}
|
|
4853
5978
|
} as const;
|
|
4854
5979
|
|
|
5980
|
+
export const $UncoveredFormatMissDto = {
|
|
5981
|
+
type: 'object',
|
|
5982
|
+
properties: {}
|
|
5983
|
+
} as const;
|
|
5984
|
+
|
|
4855
5985
|
export const $ProcessNlpDto = {
|
|
4856
5986
|
type: 'object',
|
|
4857
5987
|
properties: {
|
|
4858
5988
|
message: {
|
|
4859
5989
|
type: 'string',
|
|
4860
|
-
description:
|
|
4861
|
-
|
|
5990
|
+
description:
|
|
5991
|
+
'Natural language text describing a transaction. Optional when `confirm` is true (structured confirm); otherwise required.',
|
|
5992
|
+
example: 'Starbucks 35',
|
|
4862
5993
|
maxLength: 500
|
|
4863
5994
|
},
|
|
5995
|
+
confirm: {
|
|
5996
|
+
type: 'boolean',
|
|
5997
|
+
description:
|
|
5998
|
+
'Structured confirm signal — bypasses NL confirm-word matching when true. Send parsedData field edits alongside. The NL word-list path is the fallback.',
|
|
5999
|
+
example: true
|
|
6000
|
+
},
|
|
4864
6001
|
sessionId: {
|
|
4865
6002
|
type: 'string',
|
|
4866
6003
|
description:
|
|
@@ -4876,9 +6013,20 @@ export const $ProcessNlpDto = {
|
|
|
4876
6013
|
currency: 'CNY',
|
|
4877
6014
|
payee: 'Starbucks'
|
|
4878
6015
|
}
|
|
6016
|
+
},
|
|
6017
|
+
selectedRuleId: {
|
|
6018
|
+
type: 'string',
|
|
6019
|
+
description:
|
|
6020
|
+
'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.',
|
|
6021
|
+
example: 'rule_abc123'
|
|
6022
|
+
},
|
|
6023
|
+
selectedAccount: {
|
|
6024
|
+
type: 'string',
|
|
6025
|
+
description:
|
|
6026
|
+
'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.',
|
|
6027
|
+
example: 'Expenses:Food:Coffee'
|
|
4879
6028
|
}
|
|
4880
|
-
}
|
|
4881
|
-
required: ['message']
|
|
6029
|
+
}
|
|
4882
6030
|
} as const;
|
|
4883
6031
|
|
|
4884
6032
|
export const $NlpTransactionInfoDto = {
|
|
@@ -5200,7 +6348,8 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5200
6348
|
},
|
|
5201
6349
|
suggestedAccount: {
|
|
5202
6350
|
type: 'string',
|
|
5203
|
-
description:
|
|
6351
|
+
description:
|
|
6352
|
+
'Suggested replacement account (omitted when no clear candidate)',
|
|
5204
6353
|
example: 'Expenses:Food:Drinks'
|
|
5205
6354
|
},
|
|
5206
6355
|
similarAccounts: {
|
|
@@ -5222,7 +6371,6 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5222
6371
|
},
|
|
5223
6372
|
required: [
|
|
5224
6373
|
'invalidAccount',
|
|
5225
|
-
'suggestedAccount',
|
|
5226
6374
|
'similarAccounts',
|
|
5227
6375
|
'errorMessage',
|
|
5228
6376
|
'transactionContext'
|
|
@@ -5391,11 +6539,12 @@ export const $NlpSuggestedAccountDto = {
|
|
|
5391
6539
|
account: {
|
|
5392
6540
|
type: 'string',
|
|
5393
6541
|
description: 'Suggested account path',
|
|
5394
|
-
example: 'Assets:
|
|
6542
|
+
example: 'Assets:Checking'
|
|
5395
6543
|
},
|
|
5396
6544
|
confidence: {
|
|
5397
6545
|
type: 'number',
|
|
5398
|
-
description:
|
|
6546
|
+
description:
|
|
6547
|
+
'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
|
|
5399
6548
|
example: 0.9
|
|
5400
6549
|
}
|
|
5401
6550
|
},
|
|
@@ -5431,23 +6580,31 @@ export const $NlpDefaultAccountsDto = {
|
|
|
5431
6580
|
properties: {
|
|
5432
6581
|
asset: {
|
|
5433
6582
|
type: 'string',
|
|
5434
|
-
description:
|
|
5435
|
-
|
|
6583
|
+
description:
|
|
6584
|
+
'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
|
|
6585
|
+
example: 'Assets:Checking',
|
|
6586
|
+
nullable: true
|
|
5436
6587
|
},
|
|
5437
6588
|
expense: {
|
|
5438
6589
|
type: 'string',
|
|
5439
|
-
description:
|
|
5440
|
-
|
|
6590
|
+
description:
|
|
6591
|
+
'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
|
|
6592
|
+
example: 'Expenses:Food:Coffee',
|
|
6593
|
+
nullable: true
|
|
5441
6594
|
},
|
|
5442
6595
|
income: {
|
|
5443
6596
|
type: 'string',
|
|
5444
|
-
description:
|
|
5445
|
-
|
|
6597
|
+
description:
|
|
6598
|
+
'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
|
|
6599
|
+
example: 'Income:Salary',
|
|
6600
|
+
nullable: true
|
|
5446
6601
|
},
|
|
5447
6602
|
liability: {
|
|
5448
6603
|
type: 'string',
|
|
5449
|
-
description:
|
|
5450
|
-
|
|
6604
|
+
description:
|
|
6605
|
+
'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
|
|
6606
|
+
example: 'Liabilities:CreditCard',
|
|
6607
|
+
nullable: true
|
|
5451
6608
|
}
|
|
5452
6609
|
},
|
|
5453
6610
|
required: ['asset', 'expense', 'income', 'liability']
|
|
@@ -5472,7 +6629,8 @@ export const $NlpResponseDto = {
|
|
|
5472
6629
|
'confirm_rule',
|
|
5473
6630
|
'confirm_account',
|
|
5474
6631
|
'confirm_payee',
|
|
5475
|
-
'cancel'
|
|
6632
|
+
'cancel',
|
|
6633
|
+
'aborted'
|
|
5476
6634
|
]
|
|
5477
6635
|
},
|
|
5478
6636
|
intent: {
|
|
@@ -5632,43 +6790,304 @@ export const $NlpResponseDto = {
|
|
|
5632
6790
|
}
|
|
5633
6791
|
]
|
|
5634
6792
|
},
|
|
5635
|
-
suggestedAccounts: {
|
|
5636
|
-
description:
|
|
5637
|
-
'Suggested accounts for this transaction.
|
|
5638
|
-
allOf: [
|
|
5639
|
-
{
|
|
5640
|
-
$ref: '#/components/schemas/NlpSuggestedAccountsDto'
|
|
5641
|
-
}
|
|
5642
|
-
]
|
|
6793
|
+
suggestedAccounts: {
|
|
6794
|
+
description:
|
|
6795
|
+
'Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.',
|
|
6796
|
+
allOf: [
|
|
6797
|
+
{
|
|
6798
|
+
$ref: '#/components/schemas/NlpSuggestedAccountsDto'
|
|
6799
|
+
}
|
|
6800
|
+
]
|
|
6801
|
+
},
|
|
6802
|
+
defaultAccounts: {
|
|
6803
|
+
description:
|
|
6804
|
+
'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
|
|
6805
|
+
allOf: [
|
|
6806
|
+
{
|
|
6807
|
+
$ref: '#/components/schemas/NlpDefaultAccountsDto'
|
|
6808
|
+
}
|
|
6809
|
+
]
|
|
6810
|
+
}
|
|
6811
|
+
},
|
|
6812
|
+
required: ['status', 'action']
|
|
6813
|
+
} as const;
|
|
6814
|
+
|
|
6815
|
+
export const $PlatformListItemDto = {
|
|
6816
|
+
type: 'object',
|
|
6817
|
+
properties: {
|
|
6818
|
+
id: {
|
|
6819
|
+
type: 'string',
|
|
6820
|
+
description: 'Global platform ID'
|
|
6821
|
+
},
|
|
6822
|
+
name: {
|
|
6823
|
+
type: 'string',
|
|
6824
|
+
description: 'Platform name'
|
|
6825
|
+
},
|
|
6826
|
+
url: {
|
|
6827
|
+
type: 'string',
|
|
6828
|
+
description: 'Platform URL'
|
|
6829
|
+
},
|
|
6830
|
+
type: {
|
|
6831
|
+
type: 'string',
|
|
6832
|
+
description: 'Platform type',
|
|
6833
|
+
enum: [
|
|
6834
|
+
'BANK',
|
|
6835
|
+
'BROKERAGE',
|
|
6836
|
+
'CRYPTO_EXCHANGE',
|
|
6837
|
+
'PAYMENT',
|
|
6838
|
+
'INVESTMENT',
|
|
6839
|
+
'INSURANCE',
|
|
6840
|
+
'OTHER'
|
|
6841
|
+
]
|
|
6842
|
+
},
|
|
6843
|
+
canonical: {
|
|
6844
|
+
type: 'string',
|
|
6845
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
6846
|
+
},
|
|
6847
|
+
suggestedSegment: {
|
|
6848
|
+
type: 'string',
|
|
6849
|
+
description:
|
|
6850
|
+
'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
|
|
6851
|
+
},
|
|
6852
|
+
logoUrl: {
|
|
6853
|
+
type: 'string',
|
|
6854
|
+
description: 'Logo URL',
|
|
6855
|
+
nullable: true
|
|
6856
|
+
},
|
|
6857
|
+
countryCode: {
|
|
6858
|
+
type: 'string',
|
|
6859
|
+
description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
|
|
6860
|
+
example: 'CN',
|
|
6861
|
+
nullable: true
|
|
6862
|
+
},
|
|
6863
|
+
category: {
|
|
6864
|
+
type: 'string',
|
|
6865
|
+
description:
|
|
6866
|
+
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
|
|
6867
|
+
nullable: true,
|
|
6868
|
+
example: 'DigitalWallet'
|
|
6869
|
+
},
|
|
6870
|
+
isBound: {
|
|
6871
|
+
type: 'boolean',
|
|
6872
|
+
description: 'Whether user has accounts using this platform'
|
|
6873
|
+
}
|
|
6874
|
+
},
|
|
6875
|
+
required: [
|
|
6876
|
+
'id',
|
|
6877
|
+
'name',
|
|
6878
|
+
'url',
|
|
6879
|
+
'type',
|
|
6880
|
+
'canonical',
|
|
6881
|
+
'suggestedSegment',
|
|
6882
|
+
'logoUrl',
|
|
6883
|
+
'countryCode',
|
|
6884
|
+
'category',
|
|
6885
|
+
'isBound'
|
|
6886
|
+
]
|
|
6887
|
+
} as const;
|
|
6888
|
+
|
|
6889
|
+
export const $PlatformMatchResultDto = {
|
|
6890
|
+
type: 'object',
|
|
6891
|
+
properties: {
|
|
6892
|
+
id: {
|
|
6893
|
+
type: 'string',
|
|
6894
|
+
description: 'Global platform ID'
|
|
6895
|
+
},
|
|
6896
|
+
name: {
|
|
6897
|
+
type: 'string',
|
|
6898
|
+
description: 'Platform name (e.g., "ICBC")'
|
|
6899
|
+
},
|
|
6900
|
+
canonical: {
|
|
6901
|
+
type: 'string',
|
|
6902
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
6903
|
+
},
|
|
6904
|
+
type: {
|
|
6905
|
+
type: 'string',
|
|
6906
|
+
description: 'Platform type',
|
|
6907
|
+
enum: [
|
|
6908
|
+
'BANK',
|
|
6909
|
+
'BROKERAGE',
|
|
6910
|
+
'CRYPTO_EXCHANGE',
|
|
6911
|
+
'PAYMENT',
|
|
6912
|
+
'INVESTMENT',
|
|
6913
|
+
'INSURANCE',
|
|
6914
|
+
'OTHER'
|
|
6915
|
+
]
|
|
6916
|
+
},
|
|
6917
|
+
suggestedSegment: {
|
|
6918
|
+
type: 'string',
|
|
6919
|
+
description:
|
|
6920
|
+
'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
|
|
6921
|
+
},
|
|
6922
|
+
logoUrl: {
|
|
6923
|
+
type: 'string',
|
|
6924
|
+
description: 'Logo URL',
|
|
6925
|
+
nullable: true
|
|
6926
|
+
},
|
|
6927
|
+
countryCode: {
|
|
6928
|
+
type: 'string',
|
|
6929
|
+
description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
|
|
6930
|
+
example: 'CN',
|
|
6931
|
+
nullable: true
|
|
6932
|
+
},
|
|
6933
|
+
category: {
|
|
6934
|
+
type: 'string',
|
|
6935
|
+
description:
|
|
6936
|
+
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
|
|
6937
|
+
nullable: true,
|
|
6938
|
+
example: 'DigitalWallet'
|
|
6939
|
+
},
|
|
6940
|
+
matchType: {
|
|
6941
|
+
type: 'string',
|
|
6942
|
+
description: "How this row matched: 'exact' > 'prefix' > 'substring'",
|
|
6943
|
+
enum: ['exact', 'prefix', 'substring']
|
|
6944
|
+
}
|
|
6945
|
+
},
|
|
6946
|
+
required: [
|
|
6947
|
+
'id',
|
|
6948
|
+
'name',
|
|
6949
|
+
'canonical',
|
|
6950
|
+
'type',
|
|
6951
|
+
'suggestedSegment',
|
|
6952
|
+
'logoUrl',
|
|
6953
|
+
'countryCode',
|
|
6954
|
+
'category',
|
|
6955
|
+
'matchType'
|
|
6956
|
+
]
|
|
6957
|
+
} as const;
|
|
6958
|
+
|
|
6959
|
+
export const $PlatformMatchResponseDto = {
|
|
6960
|
+
type: 'object',
|
|
6961
|
+
properties: {
|
|
6962
|
+
platforms: {
|
|
6963
|
+
description: 'Ranked matches, best tier first (at most 10 rows)',
|
|
6964
|
+
type: 'array',
|
|
6965
|
+
items: {
|
|
6966
|
+
$ref: '#/components/schemas/PlatformMatchResultDto'
|
|
6967
|
+
}
|
|
6968
|
+
},
|
|
6969
|
+
matchType: {
|
|
6970
|
+
type: 'string',
|
|
6971
|
+
description:
|
|
6972
|
+
"Overall match quality — top row's tier, or 'none' when no hits",
|
|
6973
|
+
enum: ['none', 'exact', 'prefix', 'substring']
|
|
6974
|
+
},
|
|
6975
|
+
total: {
|
|
6976
|
+
type: 'number',
|
|
6977
|
+
description: 'Total matches before LIMIT (truncation transparency)'
|
|
6978
|
+
},
|
|
6979
|
+
hasMore: {
|
|
6980
|
+
type: 'boolean',
|
|
6981
|
+
description: 'true when total > platforms.length (more matches exist)'
|
|
6982
|
+
}
|
|
6983
|
+
},
|
|
6984
|
+
required: ['platforms', 'matchType', 'total', 'hasMore']
|
|
6985
|
+
} as const;
|
|
6986
|
+
|
|
6987
|
+
export const $CreatePlatformDto = {
|
|
6988
|
+
type: 'object',
|
|
6989
|
+
properties: {
|
|
6990
|
+
name: {
|
|
6991
|
+
type: 'string',
|
|
6992
|
+
description: 'Platform name',
|
|
6993
|
+
example: 'Binance'
|
|
6994
|
+
},
|
|
6995
|
+
canonical: {
|
|
6996
|
+
type: 'string',
|
|
6997
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
6998
|
+
example: 'binance'
|
|
6999
|
+
},
|
|
7000
|
+
aliases: {
|
|
7001
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
7002
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
7003
|
+
type: 'array',
|
|
7004
|
+
items: {
|
|
7005
|
+
type: 'string'
|
|
7006
|
+
}
|
|
7007
|
+
},
|
|
7008
|
+
url: {
|
|
7009
|
+
type: 'string',
|
|
7010
|
+
description: 'Platform URL',
|
|
7011
|
+
example: 'https://www.binance.com'
|
|
7012
|
+
},
|
|
7013
|
+
type: {
|
|
7014
|
+
type: 'string',
|
|
7015
|
+
description: 'Platform type',
|
|
7016
|
+
enum: [
|
|
7017
|
+
'BANK',
|
|
7018
|
+
'BROKERAGE',
|
|
7019
|
+
'CRYPTO_EXCHANGE',
|
|
7020
|
+
'PAYMENT',
|
|
7021
|
+
'INVESTMENT',
|
|
7022
|
+
'INSURANCE',
|
|
7023
|
+
'OTHER'
|
|
7024
|
+
],
|
|
7025
|
+
example: 'CRYPTO_EXCHANGE'
|
|
7026
|
+
},
|
|
7027
|
+
logoUrl: {
|
|
7028
|
+
type: 'string',
|
|
7029
|
+
description: 'Platform logo URL',
|
|
7030
|
+
example: 'https://example.com/logos/binance.png'
|
|
5643
7031
|
},
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
{
|
|
5649
|
-
$ref: '#/components/schemas/NlpDefaultAccountsDto'
|
|
5650
|
-
}
|
|
5651
|
-
]
|
|
7032
|
+
isActive: {
|
|
7033
|
+
type: 'boolean',
|
|
7034
|
+
description: 'Whether the platform is active',
|
|
7035
|
+
default: true
|
|
5652
7036
|
}
|
|
5653
7037
|
},
|
|
5654
|
-
required: ['
|
|
7038
|
+
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
5655
7039
|
} as const;
|
|
5656
7040
|
|
|
5657
|
-
export const $
|
|
7041
|
+
export const $UpdatePlatformDto = {
|
|
5658
7042
|
type: 'object',
|
|
5659
7043
|
properties: {
|
|
5660
|
-
|
|
7044
|
+
name: {
|
|
5661
7045
|
type: 'string',
|
|
5662
|
-
description: '
|
|
5663
|
-
example: '
|
|
7046
|
+
description: 'Platform name',
|
|
7047
|
+
example: 'Binance'
|
|
5664
7048
|
},
|
|
5665
|
-
|
|
7049
|
+
canonical: {
|
|
5666
7050
|
type: 'string',
|
|
5667
|
-
description: '
|
|
5668
|
-
example: '
|
|
7051
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
7052
|
+
example: 'binance'
|
|
7053
|
+
},
|
|
7054
|
+
aliases: {
|
|
7055
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
7056
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
7057
|
+
type: 'array',
|
|
7058
|
+
items: {
|
|
7059
|
+
type: 'string'
|
|
7060
|
+
}
|
|
7061
|
+
},
|
|
7062
|
+
url: {
|
|
7063
|
+
type: 'string',
|
|
7064
|
+
description: 'Platform URL',
|
|
7065
|
+
example: 'https://www.binance.com'
|
|
7066
|
+
},
|
|
7067
|
+
type: {
|
|
7068
|
+
type: 'string',
|
|
7069
|
+
description: 'Platform type',
|
|
7070
|
+
enum: [
|
|
7071
|
+
'BANK',
|
|
7072
|
+
'BROKERAGE',
|
|
7073
|
+
'CRYPTO_EXCHANGE',
|
|
7074
|
+
'PAYMENT',
|
|
7075
|
+
'INVESTMENT',
|
|
7076
|
+
'INSURANCE',
|
|
7077
|
+
'OTHER'
|
|
7078
|
+
],
|
|
7079
|
+
example: 'CRYPTO_EXCHANGE'
|
|
7080
|
+
},
|
|
7081
|
+
logoUrl: {
|
|
7082
|
+
type: 'string',
|
|
7083
|
+
description: 'Platform logo URL',
|
|
7084
|
+
example: 'https://example.com/logos/binance.png'
|
|
7085
|
+
},
|
|
7086
|
+
isActive: {
|
|
7087
|
+
type: 'boolean',
|
|
7088
|
+
description: 'Whether the platform is active'
|
|
5669
7089
|
}
|
|
5670
|
-
}
|
|
5671
|
-
required: ['currency', 'balance']
|
|
7090
|
+
}
|
|
5672
7091
|
} as const;
|
|
5673
7092
|
|
|
5674
7093
|
export const $NetWorthByCurrencyDto = {
|
|
@@ -5740,28 +7159,6 @@ export const $ConvertedNetWorthDto = {
|
|
|
5740
7159
|
]
|
|
5741
7160
|
} as const;
|
|
5742
7161
|
|
|
5743
|
-
export const $ExchangeRateWarningDto = {
|
|
5744
|
-
type: 'object',
|
|
5745
|
-
properties: {
|
|
5746
|
-
type: {
|
|
5747
|
-
type: 'string',
|
|
5748
|
-
description: 'Warning type',
|
|
5749
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
5750
|
-
},
|
|
5751
|
-
currency: {
|
|
5752
|
-
type: 'string',
|
|
5753
|
-
description: 'Currency without exchange rate',
|
|
5754
|
-
example: 'EUR'
|
|
5755
|
-
},
|
|
5756
|
-
totalAmount: {
|
|
5757
|
-
type: 'string',
|
|
5758
|
-
description: 'Total amount affected',
|
|
5759
|
-
example: '1000.00'
|
|
5760
|
-
}
|
|
5761
|
-
},
|
|
5762
|
-
required: ['type', 'currency', 'totalAmount']
|
|
5763
|
-
} as const;
|
|
5764
|
-
|
|
5765
7162
|
export const $NetWorthResponseDto = {
|
|
5766
7163
|
type: 'object',
|
|
5767
7164
|
properties: {
|
|
@@ -5847,7 +7244,7 @@ export const $AccountItemDto = {
|
|
|
5847
7244
|
name: {
|
|
5848
7245
|
type: 'string',
|
|
5849
7246
|
description: 'Full account name',
|
|
5850
|
-
example: 'Assets:
|
|
7247
|
+
example: 'Assets:CN:CMB:Savings'
|
|
5851
7248
|
},
|
|
5852
7249
|
displayName: {
|
|
5853
7250
|
type: 'string',
|
|
@@ -5863,6 +7260,12 @@ export const $AccountItemDto = {
|
|
|
5863
7260
|
type: 'string',
|
|
5864
7261
|
description: 'Currency code',
|
|
5865
7262
|
example: 'CNY'
|
|
7263
|
+
},
|
|
7264
|
+
convertedBalance: {
|
|
7265
|
+
type: 'string',
|
|
7266
|
+
description:
|
|
7267
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7268
|
+
example: '50000.00'
|
|
5866
7269
|
}
|
|
5867
7270
|
},
|
|
5868
7271
|
required: ['id', 'name', 'displayName', 'balance', 'currency']
|
|
@@ -5889,11 +7292,66 @@ export const $PlatformGroupDto = {
|
|
|
5889
7292
|
},
|
|
5890
7293
|
totalBalance: {
|
|
5891
7294
|
type: 'string',
|
|
5892
|
-
description: '
|
|
7295
|
+
description: 'FX-converted total balance in base currency',
|
|
7296
|
+
example: '100000.00'
|
|
7297
|
+
},
|
|
7298
|
+
balanceByCurrency: {
|
|
7299
|
+
description: 'Raw (unconverted) balances grouped by currency',
|
|
7300
|
+
type: 'array',
|
|
7301
|
+
items: {
|
|
7302
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7303
|
+
}
|
|
7304
|
+
},
|
|
7305
|
+
convertedBalance: {
|
|
7306
|
+
type: 'string',
|
|
7307
|
+
description:
|
|
7308
|
+
'Converted balance in base currency (omitted when no currency is convertible)',
|
|
5893
7309
|
example: '100000.00'
|
|
7310
|
+
},
|
|
7311
|
+
sharePct: {
|
|
7312
|
+
type: 'number',
|
|
7313
|
+
description:
|
|
7314
|
+
'Share of the grand converted total (0-100); 0 when grand total is 0',
|
|
7315
|
+
example: 42.5
|
|
7316
|
+
}
|
|
7317
|
+
},
|
|
7318
|
+
required: [
|
|
7319
|
+
'platformId',
|
|
7320
|
+
'platformName',
|
|
7321
|
+
'accounts',
|
|
7322
|
+
'totalBalance',
|
|
7323
|
+
'balanceByCurrency',
|
|
7324
|
+
'sharePct'
|
|
7325
|
+
]
|
|
7326
|
+
} as const;
|
|
7327
|
+
|
|
7328
|
+
export const $AccountExchangeRateWarningDto = {
|
|
7329
|
+
type: 'object',
|
|
7330
|
+
properties: {
|
|
7331
|
+
type: {
|
|
7332
|
+
type: 'string',
|
|
7333
|
+
description: 'Warning type',
|
|
7334
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
7335
|
+
},
|
|
7336
|
+
currency: {
|
|
7337
|
+
type: 'string',
|
|
7338
|
+
description: 'Currency without exchange rate',
|
|
7339
|
+
example: 'USD'
|
|
7340
|
+
},
|
|
7341
|
+
accounts: {
|
|
7342
|
+
description: 'Affected account paths',
|
|
7343
|
+
type: 'array',
|
|
7344
|
+
items: {
|
|
7345
|
+
type: 'string'
|
|
7346
|
+
}
|
|
7347
|
+
},
|
|
7348
|
+
totalAmount: {
|
|
7349
|
+
type: 'string',
|
|
7350
|
+
description: 'Total amount in this currency',
|
|
7351
|
+
example: '5000.00'
|
|
5894
7352
|
}
|
|
5895
7353
|
},
|
|
5896
|
-
required: ['
|
|
7354
|
+
required: ['type', 'currency', 'accounts', 'totalAmount']
|
|
5897
7355
|
} as const;
|
|
5898
7356
|
|
|
5899
7357
|
export const $AccountsSummaryDto = {
|
|
@@ -5906,9 +7364,21 @@ export const $AccountsSummaryDto = {
|
|
|
5906
7364
|
totalPlatforms: {
|
|
5907
7365
|
type: 'number',
|
|
5908
7366
|
description: 'Total number of platforms'
|
|
7367
|
+
},
|
|
7368
|
+
baseCurrency: {
|
|
7369
|
+
type: 'string',
|
|
7370
|
+
description: 'Base currency for conversion',
|
|
7371
|
+
example: 'CNY'
|
|
7372
|
+
},
|
|
7373
|
+
warnings: {
|
|
7374
|
+
description: 'Per-account exchange rate warnings',
|
|
7375
|
+
type: 'array',
|
|
7376
|
+
items: {
|
|
7377
|
+
$ref: '#/components/schemas/AccountExchangeRateWarningDto'
|
|
7378
|
+
}
|
|
5909
7379
|
}
|
|
5910
7380
|
},
|
|
5911
|
-
required: ['totalAccounts', 'totalPlatforms']
|
|
7381
|
+
required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
|
|
5912
7382
|
} as const;
|
|
5913
7383
|
|
|
5914
7384
|
export const $AccountsResponseDto = {
|
|
@@ -5943,7 +7413,7 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
5943
7413
|
name: {
|
|
5944
7414
|
type: 'string',
|
|
5945
7415
|
description: 'Full account name',
|
|
5946
|
-
example: 'Assets:
|
|
7416
|
+
example: 'Assets:CN:CMB:Savings'
|
|
5947
7417
|
},
|
|
5948
7418
|
displayName: {
|
|
5949
7419
|
type: 'string',
|
|
@@ -5960,6 +7430,12 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
5960
7430
|
description: 'Currency code',
|
|
5961
7431
|
example: 'CNY'
|
|
5962
7432
|
},
|
|
7433
|
+
convertedBalance: {
|
|
7434
|
+
type: 'string',
|
|
7435
|
+
description:
|
|
7436
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7437
|
+
example: '50000.00'
|
|
7438
|
+
},
|
|
5963
7439
|
assetClass: {
|
|
5964
7440
|
type: 'string',
|
|
5965
7441
|
description: 'Asset class',
|
|
@@ -5979,6 +7455,12 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
5979
7455
|
type: 'string',
|
|
5980
7456
|
description: 'Risk level',
|
|
5981
7457
|
example: 'LOW'
|
|
7458
|
+
},
|
|
7459
|
+
source: {
|
|
7460
|
+
type: 'string',
|
|
7461
|
+
description:
|
|
7462
|
+
'ADR-0105 classification provenance (holding level always; account level only on FALLBACK)',
|
|
7463
|
+
enum: ['USER_META', 'FIAT_CURRENCY', 'OPENBB_MAPPING', 'FALLBACK']
|
|
5982
7464
|
}
|
|
5983
7465
|
},
|
|
5984
7466
|
required: ['id', 'name', 'displayName', 'balance', 'currency', 'assetClass']
|
|
@@ -6033,82 +7515,154 @@ export const $AssetClassGroupDto = {
|
|
|
6033
7515
|
required: ['assetClass', 'accounts', 'balanceByCurrency']
|
|
6034
7516
|
} as const;
|
|
6035
7517
|
|
|
6036
|
-
export const $
|
|
7518
|
+
export const $AssetClassSummaryDto = {
|
|
6037
7519
|
type: 'object',
|
|
6038
7520
|
properties: {
|
|
6039
|
-
|
|
6040
|
-
type: '
|
|
6041
|
-
description: '
|
|
6042
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
7521
|
+
totalAccounts: {
|
|
7522
|
+
type: 'number',
|
|
7523
|
+
description: 'Total number of accounts'
|
|
6043
7524
|
},
|
|
6044
|
-
|
|
7525
|
+
totalAssetClasses: {
|
|
7526
|
+
type: 'number',
|
|
7527
|
+
description: 'Total number of asset classes'
|
|
7528
|
+
},
|
|
7529
|
+
baseCurrency: {
|
|
6045
7530
|
type: 'string',
|
|
6046
|
-
description: '
|
|
6047
|
-
example: '
|
|
7531
|
+
description: 'Base currency for conversion',
|
|
7532
|
+
example: 'CNY'
|
|
6048
7533
|
},
|
|
6049
|
-
|
|
6050
|
-
description: '
|
|
7534
|
+
warnings: {
|
|
7535
|
+
description: 'Exchange rate warnings',
|
|
6051
7536
|
type: 'array',
|
|
6052
7537
|
items: {
|
|
6053
|
-
|
|
7538
|
+
$ref: '#/components/schemas/AccountExchangeRateWarningDto'
|
|
6054
7539
|
}
|
|
6055
7540
|
},
|
|
6056
|
-
|
|
6057
|
-
type: '
|
|
6058
|
-
description:
|
|
6059
|
-
|
|
7541
|
+
fallback: {
|
|
7542
|
+
type: 'object',
|
|
7543
|
+
description:
|
|
7544
|
+
'ADR-0105 §4 fallback provenance stats (holding level only). valueRatio is the grey-area share of total converted value; count is the number of source=FALLBACK holdings.'
|
|
6060
7545
|
}
|
|
6061
7546
|
},
|
|
6062
|
-
required: ['
|
|
7547
|
+
required: ['totalAccounts', 'totalAssetClasses', 'baseCurrency']
|
|
6063
7548
|
} as const;
|
|
6064
7549
|
|
|
6065
|
-
export const $
|
|
7550
|
+
export const $AssetClassAccountsResponseDto = {
|
|
6066
7551
|
type: 'object',
|
|
6067
7552
|
properties: {
|
|
6068
|
-
|
|
6069
|
-
|
|
6070
|
-
|
|
7553
|
+
groups: {
|
|
7554
|
+
description: 'Account groups by asset class',
|
|
7555
|
+
type: 'array',
|
|
7556
|
+
items: {
|
|
7557
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7558
|
+
}
|
|
7559
|
+
},
|
|
7560
|
+
summary: {
|
|
7561
|
+
description: 'Summary statistics',
|
|
7562
|
+
allOf: [
|
|
7563
|
+
{
|
|
7564
|
+
$ref: '#/components/schemas/AssetClassSummaryDto'
|
|
7565
|
+
}
|
|
7566
|
+
]
|
|
7567
|
+
},
|
|
7568
|
+
uncategorized: {
|
|
7569
|
+
description:
|
|
7570
|
+
'ADR-0105 §6 holding-level grey-area bucket (source=FALLBACK holdings peeled out of groups). Present only for groupBy=holdingAssetClass when FALLBACK holdings exist.',
|
|
7571
|
+
allOf: [
|
|
7572
|
+
{
|
|
7573
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7574
|
+
}
|
|
7575
|
+
]
|
|
7576
|
+
}
|
|
7577
|
+
},
|
|
7578
|
+
required: ['groups', 'summary']
|
|
7579
|
+
} as const;
|
|
7580
|
+
|
|
7581
|
+
export const $HoldingAssetClassAccountSliceDto = {
|
|
7582
|
+
type: 'object',
|
|
7583
|
+
properties: {
|
|
7584
|
+
accountId: {
|
|
7585
|
+
type: 'string',
|
|
7586
|
+
description: 'Account ID'
|
|
7587
|
+
},
|
|
7588
|
+
accountPath: {
|
|
7589
|
+
type: 'string',
|
|
7590
|
+
description: 'Full account path',
|
|
7591
|
+
example: 'Assets:US:Fidelity:Brokerage'
|
|
7592
|
+
},
|
|
7593
|
+
accountCurrency: {
|
|
7594
|
+
type: 'string',
|
|
7595
|
+
description:
|
|
7596
|
+
'Currency of the holding with the largest converted base value; undefined when no holding is convertible',
|
|
7597
|
+
example: 'USD'
|
|
7598
|
+
},
|
|
7599
|
+
marketValueBase: {
|
|
7600
|
+
type: 'string',
|
|
7601
|
+
description:
|
|
7602
|
+
"Account's market value in base currency (Σ converted holdings; grey bucket included)",
|
|
7603
|
+
example: '50000.00'
|
|
6071
7604
|
},
|
|
6072
|
-
|
|
7605
|
+
shareOfTotalPct: {
|
|
6073
7606
|
type: 'number',
|
|
6074
|
-
description:
|
|
7607
|
+
description:
|
|
7608
|
+
'Share of the global total (0-100). 0 when globalTotal is zero (no NaN/Infinity).',
|
|
7609
|
+
example: 42.5
|
|
6075
7610
|
},
|
|
6076
|
-
|
|
6077
|
-
|
|
6078
|
-
|
|
6079
|
-
|
|
7611
|
+
groups: {
|
|
7612
|
+
description: 'Per-account asset-class breakdown',
|
|
7613
|
+
type: 'array',
|
|
7614
|
+
items: {
|
|
7615
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7616
|
+
}
|
|
6080
7617
|
},
|
|
6081
|
-
|
|
6082
|
-
description:
|
|
7618
|
+
uncategorized: {
|
|
7619
|
+
description:
|
|
7620
|
+
'Per-account grey bucket (source=FALLBACK holdings, incl. broker cash)',
|
|
7621
|
+
allOf: [
|
|
7622
|
+
{
|
|
7623
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7624
|
+
}
|
|
7625
|
+
]
|
|
7626
|
+
},
|
|
7627
|
+
holdings: {
|
|
7628
|
+
description:
|
|
7629
|
+
'Every holding row for this account (account ID in each row’s `id` field)',
|
|
6083
7630
|
type: 'array',
|
|
6084
7631
|
items: {
|
|
6085
|
-
$ref: '#/components/schemas/
|
|
7632
|
+
$ref: '#/components/schemas/AccountItemWithAssetClassDto'
|
|
6086
7633
|
}
|
|
6087
7634
|
}
|
|
6088
7635
|
},
|
|
6089
|
-
required: [
|
|
7636
|
+
required: [
|
|
7637
|
+
'accountId',
|
|
7638
|
+
'accountPath',
|
|
7639
|
+
'marketValueBase',
|
|
7640
|
+
'shareOfTotalPct',
|
|
7641
|
+
'groups',
|
|
7642
|
+
'holdings'
|
|
7643
|
+
]
|
|
6090
7644
|
} as const;
|
|
6091
7645
|
|
|
6092
|
-
export const $
|
|
7646
|
+
export const $HoldingAssetClassCrossAccountResponseDto = {
|
|
6093
7647
|
type: 'object',
|
|
6094
7648
|
properties: {
|
|
6095
|
-
|
|
6096
|
-
description: '
|
|
6097
|
-
type: 'array',
|
|
6098
|
-
items: {
|
|
6099
|
-
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
6100
|
-
}
|
|
6101
|
-
},
|
|
6102
|
-
summary: {
|
|
6103
|
-
description: 'Summary statistics',
|
|
7649
|
+
global: {
|
|
7650
|
+
description: 'Merged cross-account holding aggregation',
|
|
6104
7651
|
allOf: [
|
|
6105
7652
|
{
|
|
6106
|
-
$ref: '#/components/schemas/
|
|
7653
|
+
$ref: '#/components/schemas/AssetClassAccountsResponseDto'
|
|
6107
7654
|
}
|
|
6108
7655
|
]
|
|
7656
|
+
},
|
|
7657
|
+
byAccount: {
|
|
7658
|
+
description: 'Per-account slices',
|
|
7659
|
+
type: 'array',
|
|
7660
|
+
items: {
|
|
7661
|
+
$ref: '#/components/schemas/HoldingAssetClassAccountSliceDto'
|
|
7662
|
+
}
|
|
6109
7663
|
}
|
|
6110
7664
|
},
|
|
6111
|
-
required: ['
|
|
7665
|
+
required: ['global', 'byAccount']
|
|
6112
7666
|
} as const;
|
|
6113
7667
|
|
|
6114
7668
|
export const $CashFlowByCurrencyDto = {
|
|
@@ -6210,207 +7764,582 @@ export const $CashFlowResponseDto = {
|
|
|
6210
7764
|
description: 'Cash flow grouped by original currency',
|
|
6211
7765
|
allOf: [
|
|
6212
7766
|
{
|
|
6213
|
-
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
7767
|
+
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
7768
|
+
}
|
|
7769
|
+
]
|
|
7770
|
+
},
|
|
7771
|
+
converted: {
|
|
7772
|
+
description: 'Converted values in base currency',
|
|
7773
|
+
allOf: [
|
|
7774
|
+
{
|
|
7775
|
+
$ref: '#/components/schemas/ConvertedCashFlowDto'
|
|
7776
|
+
}
|
|
7777
|
+
]
|
|
7778
|
+
},
|
|
7779
|
+
warnings: {
|
|
7780
|
+
description: 'Exchange rate warnings',
|
|
7781
|
+
type: 'array',
|
|
7782
|
+
items: {
|
|
7783
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
7784
|
+
}
|
|
7785
|
+
}
|
|
7786
|
+
},
|
|
7787
|
+
required: [
|
|
7788
|
+
'period',
|
|
7789
|
+
'income',
|
|
7790
|
+
'expense',
|
|
7791
|
+
'netSavings',
|
|
7792
|
+
'savingsRate',
|
|
7793
|
+
'currency'
|
|
7794
|
+
]
|
|
7795
|
+
} as const;
|
|
7796
|
+
|
|
7797
|
+
export const $CategoryGroupDto = {
|
|
7798
|
+
type: 'object',
|
|
7799
|
+
properties: {
|
|
7800
|
+
category: {
|
|
7801
|
+
type: 'string',
|
|
7802
|
+
description:
|
|
7803
|
+
'Functional category (account-path Group segment); regional and universal account paths merge under it',
|
|
7804
|
+
example: 'Food'
|
|
7805
|
+
},
|
|
7806
|
+
totalExpense: {
|
|
7807
|
+
type: 'string',
|
|
7808
|
+
description:
|
|
7809
|
+
'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
|
|
7810
|
+
example: '1200.00'
|
|
7811
|
+
},
|
|
7812
|
+
sharePct: {
|
|
7813
|
+
type: 'number',
|
|
7814
|
+
description: 'Share of grand total (0-100); 0 when grand total is 0',
|
|
7815
|
+
example: 42.5
|
|
7816
|
+
},
|
|
7817
|
+
balanceByCurrency: {
|
|
7818
|
+
description: 'Raw (unconverted) expense per currency',
|
|
7819
|
+
type: 'array',
|
|
7820
|
+
items: {
|
|
7821
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7822
|
+
}
|
|
7823
|
+
},
|
|
7824
|
+
convertedBalance: {
|
|
7825
|
+
type: 'string',
|
|
7826
|
+
description:
|
|
7827
|
+
'Converted total in base currency (omitted when FX missing for all currencies in this category)',
|
|
7828
|
+
example: '1200.00'
|
|
7829
|
+
}
|
|
7830
|
+
},
|
|
7831
|
+
required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
|
|
7832
|
+
} as const;
|
|
7833
|
+
|
|
7834
|
+
export const $ExpensesByCategorySummaryDto = {
|
|
7835
|
+
type: 'object',
|
|
7836
|
+
properties: {
|
|
7837
|
+
totalExpense: {
|
|
7838
|
+
type: 'string',
|
|
7839
|
+
description:
|
|
7840
|
+
'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
|
|
7841
|
+
example: '5000.00'
|
|
7842
|
+
},
|
|
7843
|
+
categoryCount: {
|
|
7844
|
+
type: 'number',
|
|
7845
|
+
description: 'Number of categories',
|
|
7846
|
+
example: 8
|
|
7847
|
+
}
|
|
7848
|
+
},
|
|
7849
|
+
required: ['totalExpense', 'categoryCount']
|
|
7850
|
+
} as const;
|
|
7851
|
+
|
|
7852
|
+
export const $ExpensesByCategoryResponseDto = {
|
|
7853
|
+
type: 'object',
|
|
7854
|
+
properties: {
|
|
7855
|
+
period: {
|
|
7856
|
+
type: 'string',
|
|
7857
|
+
description: 'Period requested',
|
|
7858
|
+
example: '1m'
|
|
7859
|
+
},
|
|
7860
|
+
baseCurrency: {
|
|
7861
|
+
type: 'string',
|
|
7862
|
+
description: 'Base currency for converted values',
|
|
7863
|
+
example: 'CNY'
|
|
7864
|
+
},
|
|
7865
|
+
groups: {
|
|
7866
|
+
description:
|
|
7867
|
+
'Expense groups by functional category, sorted by converted total desc',
|
|
7868
|
+
type: 'array',
|
|
7869
|
+
items: {
|
|
7870
|
+
$ref: '#/components/schemas/CategoryGroupDto'
|
|
7871
|
+
}
|
|
7872
|
+
},
|
|
7873
|
+
summary: {
|
|
7874
|
+
description: 'Summary statistics',
|
|
7875
|
+
allOf: [
|
|
7876
|
+
{
|
|
7877
|
+
$ref: '#/components/schemas/ExpensesByCategorySummaryDto'
|
|
7878
|
+
}
|
|
7879
|
+
]
|
|
7880
|
+
},
|
|
7881
|
+
warnings: {
|
|
7882
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
7883
|
+
type: 'array',
|
|
7884
|
+
items: {
|
|
7885
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
7886
|
+
}
|
|
7887
|
+
}
|
|
7888
|
+
},
|
|
7889
|
+
required: ['period', 'baseCurrency', 'groups', 'summary']
|
|
7890
|
+
} as const;
|
|
7891
|
+
|
|
7892
|
+
export const $MonetaryDto = {
|
|
7893
|
+
type: 'object',
|
|
7894
|
+
properties: {
|
|
7895
|
+
amount: {
|
|
7896
|
+
type: 'string',
|
|
7897
|
+
description: 'Amount (Decimal string)',
|
|
7898
|
+
example: '3000'
|
|
7899
|
+
},
|
|
7900
|
+
currency: {
|
|
7901
|
+
type: 'string',
|
|
7902
|
+
description: 'ISO 4217 currency',
|
|
7903
|
+
example: 'USD'
|
|
7904
|
+
},
|
|
7905
|
+
baseCcyEquivalent: {
|
|
7906
|
+
type: 'object',
|
|
7907
|
+
description: 'Converted to user base currency (Decimal string)',
|
|
7908
|
+
example: '21600',
|
|
7909
|
+
nullable: true
|
|
7910
|
+
}
|
|
7911
|
+
},
|
|
7912
|
+
required: ['amount', 'currency']
|
|
7913
|
+
} as const;
|
|
7914
|
+
|
|
7915
|
+
export const $CurrentPriceDto = {
|
|
7916
|
+
type: 'object',
|
|
7917
|
+
properties: {
|
|
7918
|
+
amount: {
|
|
7919
|
+
type: 'string',
|
|
7920
|
+
description: 'Price amount (Decimal string)',
|
|
7921
|
+
example: '250'
|
|
7922
|
+
},
|
|
7923
|
+
currency: {
|
|
7924
|
+
type: 'string',
|
|
7925
|
+
description: 'Price currency (ISO 4217)',
|
|
7926
|
+
example: 'USD'
|
|
7927
|
+
},
|
|
7928
|
+
date: {
|
|
7929
|
+
type: 'string',
|
|
7930
|
+
description: 'Price date (ISO 8601)',
|
|
7931
|
+
example: '2024-06-01'
|
|
7932
|
+
},
|
|
7933
|
+
source: {
|
|
7934
|
+
type: 'string',
|
|
7935
|
+
description: 'Price source',
|
|
7936
|
+
example: 'USER_OVERRIDE',
|
|
7937
|
+
enum: ['USER_OVERRIDE', 'OPENBB_EQUITY', 'OPENBB_CURRENCY']
|
|
7938
|
+
}
|
|
7939
|
+
},
|
|
7940
|
+
required: ['amount', 'currency', 'date', 'source']
|
|
7941
|
+
} as const;
|
|
7942
|
+
|
|
7943
|
+
export const $FxRateDto = {
|
|
7944
|
+
type: 'object',
|
|
7945
|
+
properties: {
|
|
7946
|
+
from: {
|
|
7947
|
+
type: 'string',
|
|
7948
|
+
example: 'USD'
|
|
7949
|
+
},
|
|
7950
|
+
to: {
|
|
7951
|
+
type: 'string',
|
|
7952
|
+
example: 'CNY'
|
|
7953
|
+
},
|
|
7954
|
+
rate: {
|
|
7955
|
+
type: 'string',
|
|
7956
|
+
description: 'FX rate (Decimal string)',
|
|
7957
|
+
example: '7.2'
|
|
7958
|
+
},
|
|
7959
|
+
date: {
|
|
7960
|
+
type: 'string',
|
|
7961
|
+
description: 'Rate date (ISO 8601)',
|
|
7962
|
+
example: '2024-01-15'
|
|
7963
|
+
}
|
|
7964
|
+
},
|
|
7965
|
+
required: ['from', 'to', 'rate', 'date']
|
|
7966
|
+
} as const;
|
|
7967
|
+
|
|
7968
|
+
export const $HoldingPnlRowDto = {
|
|
7969
|
+
type: 'object',
|
|
7970
|
+
properties: {
|
|
7971
|
+
accountId: {
|
|
7972
|
+
type: 'string',
|
|
7973
|
+
description: 'Account UUID',
|
|
7974
|
+
example: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
|
|
7975
|
+
},
|
|
7976
|
+
accountPath: {
|
|
7977
|
+
type: 'string',
|
|
7978
|
+
description: 'Full account path',
|
|
7979
|
+
example: 'Assets:US:Broker:AAPL'
|
|
7980
|
+
},
|
|
7981
|
+
accountCcy: {
|
|
7982
|
+
type: 'object',
|
|
7983
|
+
description: 'Account settlement currency (ISO 4217), from cost currency',
|
|
7984
|
+
nullable: true,
|
|
7985
|
+
example: 'USD'
|
|
7986
|
+
},
|
|
7987
|
+
brokerType: {
|
|
7988
|
+
type: 'object',
|
|
7989
|
+
description: 'Broker type derived from Platform.type',
|
|
7990
|
+
nullable: true,
|
|
7991
|
+
example: 'broker'
|
|
7992
|
+
},
|
|
7993
|
+
symbol: {
|
|
7994
|
+
type: 'string',
|
|
7995
|
+
description: 'Commodity symbol',
|
|
7996
|
+
example: 'AAPL'
|
|
7997
|
+
},
|
|
7998
|
+
chartToken: {
|
|
7999
|
+
type: 'string',
|
|
8000
|
+
description: 'Chart segment token (libs/common resolver)',
|
|
8001
|
+
example: 'equity',
|
|
8002
|
+
enum: ['equity', 'fund', 'bond', 'cash', 'other']
|
|
8003
|
+
},
|
|
8004
|
+
assetClass: {
|
|
8005
|
+
type: 'string',
|
|
8006
|
+
example: 'EQUITY'
|
|
8007
|
+
},
|
|
8008
|
+
assetSubClass: {
|
|
8009
|
+
type: 'object',
|
|
8010
|
+
nullable: true,
|
|
8011
|
+
example: 'STOCK'
|
|
8012
|
+
},
|
|
8013
|
+
units: {
|
|
8014
|
+
type: 'string',
|
|
8015
|
+
description: 'Net held units (Decimal string)',
|
|
8016
|
+
example: '12'
|
|
8017
|
+
},
|
|
8018
|
+
averageCostPerUnit: {
|
|
8019
|
+
description:
|
|
8020
|
+
'Average cost per unit; null when cost currency conflicts or no cost',
|
|
8021
|
+
nullable: true,
|
|
8022
|
+
allOf: [
|
|
8023
|
+
{
|
|
8024
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8025
|
+
}
|
|
8026
|
+
]
|
|
8027
|
+
},
|
|
8028
|
+
costBasis: {
|
|
8029
|
+
description: 'Cost basis of held units',
|
|
8030
|
+
nullable: true,
|
|
8031
|
+
allOf: [
|
|
8032
|
+
{
|
|
8033
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8034
|
+
}
|
|
8035
|
+
]
|
|
8036
|
+
},
|
|
8037
|
+
marketValue: {
|
|
8038
|
+
description: 'Market value at asOf price',
|
|
8039
|
+
nullable: true,
|
|
8040
|
+
allOf: [
|
|
8041
|
+
{
|
|
8042
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8043
|
+
}
|
|
8044
|
+
]
|
|
8045
|
+
},
|
|
8046
|
+
currentPrice: {
|
|
8047
|
+
description: 'Price used for market value',
|
|
8048
|
+
nullable: true,
|
|
8049
|
+
allOf: [
|
|
8050
|
+
{
|
|
8051
|
+
$ref: '#/components/schemas/CurrentPriceDto'
|
|
8052
|
+
}
|
|
8053
|
+
]
|
|
8054
|
+
},
|
|
8055
|
+
unrealizedPnlBase: {
|
|
8056
|
+
type: 'object',
|
|
8057
|
+
description:
|
|
8058
|
+
'Unrealized P&L in base currency (Decimal string); null when any FX/price missing',
|
|
8059
|
+
nullable: true,
|
|
8060
|
+
example: '6000'
|
|
8061
|
+
},
|
|
8062
|
+
unrealizedPnlPct: {
|
|
8063
|
+
type: 'object',
|
|
8064
|
+
description: 'Unrealized P&L % (Decimal string)',
|
|
8065
|
+
nullable: true,
|
|
8066
|
+
example: '25'
|
|
8067
|
+
},
|
|
8068
|
+
costFxRate: {
|
|
8069
|
+
description: 'Historical FX rate applied to cost basis',
|
|
8070
|
+
nullable: true,
|
|
8071
|
+
allOf: [
|
|
8072
|
+
{
|
|
8073
|
+
$ref: '#/components/schemas/FxRateDto'
|
|
6214
8074
|
}
|
|
6215
8075
|
]
|
|
6216
8076
|
},
|
|
6217
|
-
|
|
6218
|
-
description: '
|
|
8077
|
+
marketFxRate: {
|
|
8078
|
+
description: 'FX rate applied to market value',
|
|
8079
|
+
nullable: true,
|
|
6219
8080
|
allOf: [
|
|
6220
8081
|
{
|
|
6221
|
-
$ref: '#/components/schemas/
|
|
8082
|
+
$ref: '#/components/schemas/FxRateDto'
|
|
6222
8083
|
}
|
|
6223
8084
|
]
|
|
6224
8085
|
},
|
|
6225
|
-
|
|
6226
|
-
|
|
6227
|
-
|
|
6228
|
-
|
|
6229
|
-
|
|
6230
|
-
|
|
8086
|
+
pctOfInvestedAssets: {
|
|
8087
|
+
type: 'object',
|
|
8088
|
+
description:
|
|
8089
|
+
'Share of invested assets % (Decimal string); only for invested chartTokens',
|
|
8090
|
+
nullable: true,
|
|
8091
|
+
example: '40'
|
|
8092
|
+
},
|
|
8093
|
+
realizedPnl: {
|
|
8094
|
+
description:
|
|
8095
|
+
'Cumulative realized P&L on sold lots (asOf-date cutoff); null when the method has no applicable sells, a sell lacks a price, or any required FX rate is missing (never-mix). When a sell spans multiple currencies (cross-currency sale), amount and currency reflect the base currency; baseCcyEquivalent is always the authoritative dual-FX figure',
|
|
8096
|
+
nullable: true,
|
|
8097
|
+
allOf: [
|
|
8098
|
+
{
|
|
8099
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8100
|
+
}
|
|
8101
|
+
]
|
|
6231
8102
|
}
|
|
6232
8103
|
},
|
|
6233
8104
|
required: [
|
|
6234
|
-
'
|
|
6235
|
-
'
|
|
6236
|
-
'
|
|
6237
|
-
'
|
|
6238
|
-
'
|
|
6239
|
-
'
|
|
8105
|
+
'accountId',
|
|
8106
|
+
'accountPath',
|
|
8107
|
+
'symbol',
|
|
8108
|
+
'chartToken',
|
|
8109
|
+
'assetClass',
|
|
8110
|
+
'units'
|
|
6240
8111
|
]
|
|
6241
8112
|
} as const;
|
|
6242
8113
|
|
|
6243
|
-
export const $
|
|
8114
|
+
export const $HoldingPnlWarningDto = {
|
|
6244
8115
|
type: 'object',
|
|
6245
8116
|
properties: {
|
|
6246
|
-
|
|
8117
|
+
type: {
|
|
6247
8118
|
type: 'string',
|
|
6248
|
-
description: '
|
|
6249
|
-
example: '
|
|
8119
|
+
description: 'Warning type',
|
|
8120
|
+
example: 'MISSING_COST_FX_RATE',
|
|
8121
|
+
enum: [
|
|
8122
|
+
'MISSING_COST_FX_RATE',
|
|
8123
|
+
'MISSING_MARKET_FX_RATE',
|
|
8124
|
+
'MISSING_SALE_PRICE',
|
|
8125
|
+
'MISSING_REALIZED_FX_RATE',
|
|
8126
|
+
'OVERSOLD_LOTS',
|
|
8127
|
+
'NO_PRICE',
|
|
8128
|
+
'MIXED_COST_CURRENCY'
|
|
8129
|
+
]
|
|
6250
8130
|
},
|
|
6251
|
-
|
|
6252
|
-
type: '
|
|
6253
|
-
|
|
6254
|
-
|
|
8131
|
+
symbol: {
|
|
8132
|
+
type: 'object',
|
|
8133
|
+
nullable: true
|
|
8134
|
+
},
|
|
8135
|
+
accountId: {
|
|
8136
|
+
type: 'object',
|
|
8137
|
+
nullable: true
|
|
8138
|
+
},
|
|
8139
|
+
currency: {
|
|
8140
|
+
type: 'object',
|
|
8141
|
+
nullable: true
|
|
6255
8142
|
}
|
|
6256
8143
|
},
|
|
6257
|
-
required: ['
|
|
8144
|
+
required: ['type']
|
|
6258
8145
|
} as const;
|
|
6259
8146
|
|
|
6260
|
-
export const $
|
|
8147
|
+
export const $HoldingPnlResponseDto = {
|
|
6261
8148
|
type: 'object',
|
|
6262
8149
|
properties: {
|
|
6263
|
-
|
|
8150
|
+
asOfDate: {
|
|
6264
8151
|
type: 'string',
|
|
6265
|
-
|
|
6266
|
-
example: '2024-06-15'
|
|
8152
|
+
example: '2026-07-08'
|
|
6267
8153
|
},
|
|
6268
|
-
|
|
8154
|
+
baseCurrency: {
|
|
6269
8155
|
type: 'string',
|
|
6270
|
-
|
|
6271
|
-
example: '500000.00'
|
|
8156
|
+
example: 'CNY'
|
|
6272
8157
|
},
|
|
6273
|
-
|
|
6274
|
-
type: '
|
|
6275
|
-
description:
|
|
6276
|
-
|
|
8158
|
+
method: {
|
|
8159
|
+
type: 'string',
|
|
8160
|
+
description:
|
|
8161
|
+
'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
|
|
8162
|
+
enum: ['average', 'FIFO'],
|
|
8163
|
+
example: 'average'
|
|
6277
8164
|
},
|
|
6278
|
-
|
|
6279
|
-
description: 'Multi-currency breakdown for this point',
|
|
8165
|
+
rows: {
|
|
6280
8166
|
type: 'array',
|
|
6281
8167
|
items: {
|
|
6282
|
-
$ref: '#/components/schemas/
|
|
8168
|
+
$ref: '#/components/schemas/HoldingPnlRowDto'
|
|
8169
|
+
}
|
|
8170
|
+
},
|
|
8171
|
+
warnings: {
|
|
8172
|
+
type: 'array',
|
|
8173
|
+
items: {
|
|
8174
|
+
$ref: '#/components/schemas/HoldingPnlWarningDto'
|
|
6283
8175
|
}
|
|
6284
8176
|
}
|
|
6285
8177
|
},
|
|
6286
|
-
required: ['
|
|
8178
|
+
required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
|
|
6287
8179
|
} as const;
|
|
6288
8180
|
|
|
6289
|
-
export const $
|
|
8181
|
+
export const $AnonymousLoginDto = {
|
|
6290
8182
|
type: 'object',
|
|
6291
8183
|
properties: {
|
|
6292
|
-
|
|
6293
|
-
type: 'string',
|
|
6294
|
-
description: 'Value at start of period',
|
|
6295
|
-
example: '450000.00'
|
|
6296
|
-
},
|
|
6297
|
-
endValue: {
|
|
6298
|
-
type: 'string',
|
|
6299
|
-
description: 'Value at end of period',
|
|
6300
|
-
example: '500000.00'
|
|
6301
|
-
},
|
|
6302
|
-
totalChange: {
|
|
6303
|
-
type: 'string',
|
|
6304
|
-
description: 'Total change over period',
|
|
6305
|
-
example: '50000.00'
|
|
6306
|
-
},
|
|
6307
|
-
totalChangePercentage: {
|
|
8184
|
+
accessToken: {
|
|
6308
8185
|
type: 'string',
|
|
6309
|
-
description: '
|
|
6310
|
-
example: '+11.11%'
|
|
8186
|
+
description: 'Access token for anonymous login'
|
|
6311
8187
|
}
|
|
6312
8188
|
},
|
|
6313
|
-
required: ['
|
|
8189
|
+
required: ['accessToken']
|
|
6314
8190
|
} as const;
|
|
6315
8191
|
|
|
6316
|
-
export const $
|
|
8192
|
+
export const $AnonymousLoginResponseDto = {
|
|
6317
8193
|
type: 'object',
|
|
6318
8194
|
properties: {
|
|
6319
|
-
|
|
8195
|
+
authToken: {
|
|
6320
8196
|
type: 'string',
|
|
6321
|
-
description: '
|
|
6322
|
-
example: '
|
|
6323
|
-
},
|
|
6324
|
-
byCurrency: {
|
|
6325
|
-
description: 'Balances by currency',
|
|
6326
|
-
type: 'array',
|
|
6327
|
-
items: {
|
|
6328
|
-
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
6329
|
-
}
|
|
8197
|
+
description: 'JWT auth token',
|
|
8198
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
6330
8199
|
}
|
|
6331
8200
|
},
|
|
6332
|
-
required: ['
|
|
8201
|
+
required: ['authToken']
|
|
6333
8202
|
} as const;
|
|
6334
8203
|
|
|
6335
|
-
export const $
|
|
8204
|
+
export const $SymbolSearchResultDto = {
|
|
6336
8205
|
type: 'object',
|
|
6337
8206
|
properties: {
|
|
6338
|
-
|
|
6339
|
-
|
|
6340
|
-
|
|
6341
|
-
items: {
|
|
6342
|
-
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
6343
|
-
}
|
|
8207
|
+
symbol: {
|
|
8208
|
+
type: 'string',
|
|
8209
|
+
example: 'AAPL'
|
|
6344
8210
|
},
|
|
6345
|
-
|
|
6346
|
-
|
|
6347
|
-
|
|
6348
|
-
|
|
6349
|
-
$ref: '#/components/schemas/TrendSummaryDto'
|
|
6350
|
-
}
|
|
6351
|
-
]
|
|
8211
|
+
name: {
|
|
8212
|
+
type: 'object',
|
|
8213
|
+
example: 'Apple Inc.',
|
|
8214
|
+
nullable: true
|
|
6352
8215
|
},
|
|
6353
|
-
|
|
6354
|
-
type: '
|
|
6355
|
-
|
|
6356
|
-
|
|
8216
|
+
exchange: {
|
|
8217
|
+
type: 'object',
|
|
8218
|
+
example: 'US',
|
|
8219
|
+
nullable: true
|
|
6357
8220
|
},
|
|
6358
|
-
|
|
6359
|
-
type: '
|
|
6360
|
-
description: '
|
|
6361
|
-
example: '
|
|
8221
|
+
assetType: {
|
|
8222
|
+
type: 'object',
|
|
8223
|
+
description: 'OpenBB asset_type (e.g. stock, etf)',
|
|
8224
|
+
example: 'stock',
|
|
8225
|
+
nullable: true
|
|
6362
8226
|
},
|
|
6363
|
-
|
|
6364
|
-
type: '
|
|
6365
|
-
description: '
|
|
6366
|
-
example: '
|
|
8227
|
+
assetClass: {
|
|
8228
|
+
type: 'object',
|
|
8229
|
+
description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
|
|
8230
|
+
example: 'EQUITY',
|
|
8231
|
+
nullable: true
|
|
6367
8232
|
},
|
|
6368
|
-
|
|
6369
|
-
|
|
6370
|
-
|
|
6371
|
-
|
|
6372
|
-
|
|
6373
|
-
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
6374
|
-
}
|
|
8233
|
+
assetSubClass: {
|
|
8234
|
+
type: 'object',
|
|
8235
|
+
description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
|
|
8236
|
+
example: 'STOCK',
|
|
8237
|
+
nullable: true
|
|
6375
8238
|
},
|
|
6376
|
-
|
|
6377
|
-
|
|
6378
|
-
|
|
6379
|
-
|
|
6380
|
-
|
|
6381
|
-
}
|
|
8239
|
+
currency: {
|
|
8240
|
+
type: 'object',
|
|
8241
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8242
|
+
example: 'USD',
|
|
8243
|
+
nullable: true
|
|
6382
8244
|
}
|
|
6383
8245
|
},
|
|
6384
|
-
required: ['
|
|
6385
|
-
} as const;
|
|
6386
|
-
|
|
6387
|
-
export const $GenerateSnapshotBody = {
|
|
6388
|
-
type: 'object',
|
|
6389
|
-
properties: {}
|
|
6390
|
-
} as const;
|
|
6391
|
-
|
|
6392
|
-
export const $GenerateSnapshotResponse = {
|
|
6393
|
-
type: 'object',
|
|
6394
|
-
properties: {}
|
|
6395
|
-
} as const;
|
|
6396
|
-
|
|
6397
|
-
export const $BackfillSnapshotsBody = {
|
|
6398
|
-
type: 'object',
|
|
6399
|
-
properties: {}
|
|
6400
|
-
} as const;
|
|
6401
|
-
|
|
6402
|
-
export const $BackfillSnapshotsResponse = {
|
|
6403
|
-
type: 'object',
|
|
6404
|
-
properties: {}
|
|
8246
|
+
required: ['symbol']
|
|
6405
8247
|
} as const;
|
|
6406
8248
|
|
|
6407
|
-
export const $
|
|
8249
|
+
export const $SymbolQuoteDto = {
|
|
6408
8250
|
type: 'object',
|
|
6409
8251
|
properties: {
|
|
6410
|
-
|
|
8252
|
+
symbol: {
|
|
6411
8253
|
type: 'string',
|
|
6412
|
-
|
|
8254
|
+
example: 'AAPL'
|
|
8255
|
+
},
|
|
8256
|
+
name: {
|
|
8257
|
+
type: 'object',
|
|
8258
|
+
example: 'Apple Inc.',
|
|
8259
|
+
nullable: true
|
|
8260
|
+
},
|
|
8261
|
+
exchange: {
|
|
8262
|
+
type: 'object',
|
|
8263
|
+
example: 'US',
|
|
8264
|
+
nullable: true
|
|
8265
|
+
},
|
|
8266
|
+
assetType: {
|
|
8267
|
+
type: 'object',
|
|
8268
|
+
description: 'OpenBB asset_type',
|
|
8269
|
+
example: 'stock',
|
|
8270
|
+
nullable: true
|
|
8271
|
+
},
|
|
8272
|
+
assetClass: {
|
|
8273
|
+
type: 'object',
|
|
8274
|
+
description: 'IGN asset class',
|
|
8275
|
+
example: 'EQUITY',
|
|
8276
|
+
nullable: true
|
|
8277
|
+
},
|
|
8278
|
+
assetSubClass: {
|
|
8279
|
+
type: 'object',
|
|
8280
|
+
description: 'IGN asset sub-class',
|
|
8281
|
+
example: 'STOCK',
|
|
8282
|
+
nullable: true
|
|
8283
|
+
},
|
|
8284
|
+
currency: {
|
|
8285
|
+
type: 'object',
|
|
8286
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8287
|
+
example: 'USD',
|
|
8288
|
+
nullable: true
|
|
8289
|
+
},
|
|
8290
|
+
price: {
|
|
8291
|
+
type: 'object',
|
|
8292
|
+
description: 'Latest price (Decimal string)',
|
|
8293
|
+
example: '189.84',
|
|
8294
|
+
nullable: true
|
|
8295
|
+
},
|
|
8296
|
+
priceDate: {
|
|
8297
|
+
type: 'object',
|
|
8298
|
+
description: 'Date the price was observed (ISO yyyy-MM-dd)',
|
|
8299
|
+
example: '2026-08-05',
|
|
8300
|
+
nullable: true
|
|
8301
|
+
},
|
|
8302
|
+
changePercent: {
|
|
8303
|
+
type: 'object',
|
|
8304
|
+
description:
|
|
8305
|
+
'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.',
|
|
8306
|
+
example: 1.7,
|
|
8307
|
+
nullable: true
|
|
8308
|
+
},
|
|
8309
|
+
prevClose: {
|
|
8310
|
+
type: 'object',
|
|
8311
|
+
description: 'Previous close (Decimal string)',
|
|
8312
|
+
nullable: true
|
|
8313
|
+
},
|
|
8314
|
+
open: {
|
|
8315
|
+
type: 'object',
|
|
8316
|
+
description: 'Day open (Decimal string)',
|
|
8317
|
+
nullable: true
|
|
8318
|
+
},
|
|
8319
|
+
high: {
|
|
8320
|
+
type: 'object',
|
|
8321
|
+
description: 'Day high (Decimal string)',
|
|
8322
|
+
nullable: true
|
|
8323
|
+
},
|
|
8324
|
+
low: {
|
|
8325
|
+
type: 'object',
|
|
8326
|
+
description: 'Day low (Decimal string)',
|
|
8327
|
+
nullable: true
|
|
8328
|
+
},
|
|
8329
|
+
volume: {
|
|
8330
|
+
type: 'object',
|
|
8331
|
+
description: 'Day volume (Decimal string)',
|
|
8332
|
+
nullable: true
|
|
8333
|
+
},
|
|
8334
|
+
yearHigh: {
|
|
8335
|
+
type: 'object',
|
|
8336
|
+
description: '52-week high (Decimal string)',
|
|
8337
|
+
nullable: true
|
|
8338
|
+
},
|
|
8339
|
+
yearLow: {
|
|
8340
|
+
type: 'object',
|
|
8341
|
+
description: '52-week low (Decimal string)',
|
|
8342
|
+
nullable: true
|
|
6413
8343
|
}
|
|
6414
|
-
}
|
|
6415
|
-
required: ['accessToken']
|
|
8344
|
+
}
|
|
6416
8345
|
} as const;
|