@firela/api-types 0.0.0-canary.cf050c09 → 0.0.0-canary.d190ee29
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 +4615 -2521
- package/dist/index.d.ts +4615 -2521
- package/dist/index.js +34 -6
- package/dist/index.mjs +34 -6
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +2846 -723
- package/src/generated/services.gen.ts +1309 -410
- package/src/generated/types.gen.ts +7882 -2834
|
@@ -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,612 @@ 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 $UserSettingsResponseDto = {
|
|
4127
|
+
type: 'object',
|
|
4128
|
+
properties: {
|
|
4129
|
+
baseCurrency: {
|
|
4130
|
+
type: 'string',
|
|
4131
|
+
description:
|
|
4132
|
+
'Base currency (ISO 4217) for net-worth/report aggregation. Independent of region (ADR-0006).',
|
|
4133
|
+
example: 'USD',
|
|
4134
|
+
nullable: true
|
|
4135
|
+
}
|
|
4136
|
+
},
|
|
4137
|
+
required: ['baseCurrency']
|
|
4138
|
+
} as const;
|
|
4139
|
+
|
|
4140
|
+
export const $UserResponseDto = {
|
|
4141
|
+
type: 'object',
|
|
4142
|
+
properties: {
|
|
4143
|
+
id: {
|
|
4144
|
+
type: 'string',
|
|
4145
|
+
description: 'User ID'
|
|
4146
|
+
},
|
|
4147
|
+
role: {
|
|
4148
|
+
type: 'string',
|
|
4149
|
+
description: 'Assigned user role'
|
|
4150
|
+
},
|
|
4151
|
+
permissions: {
|
|
4152
|
+
description: 'Permission strings',
|
|
4153
|
+
type: 'array',
|
|
4154
|
+
items: {
|
|
4155
|
+
type: 'string'
|
|
4156
|
+
}
|
|
4157
|
+
},
|
|
4158
|
+
settings: {
|
|
4159
|
+
description: 'User settings',
|
|
4160
|
+
allOf: [
|
|
4161
|
+
{
|
|
4162
|
+
$ref: '#/components/schemas/UserSettingsResponseDto'
|
|
4163
|
+
}
|
|
4164
|
+
]
|
|
4165
|
+
}
|
|
4166
|
+
},
|
|
4167
|
+
required: ['id', 'role', 'permissions', 'settings']
|
|
4168
|
+
} as const;
|
|
4169
|
+
|
|
4170
|
+
export const $SignupDto = {
|
|
4171
|
+
type: 'object',
|
|
4172
|
+
properties: {
|
|
4173
|
+
turnstileToken: {
|
|
4174
|
+
type: 'string',
|
|
4175
|
+
description:
|
|
4176
|
+
'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
|
|
4177
|
+
example: '0.abc123def456...'
|
|
4178
|
+
}
|
|
4179
|
+
}
|
|
4180
|
+
} as const;
|
|
4181
|
+
|
|
4182
|
+
export const $SignupResponseDto = {
|
|
4183
|
+
type: 'object',
|
|
4184
|
+
properties: {
|
|
4185
|
+
authToken: {
|
|
4186
|
+
type: 'string',
|
|
4187
|
+
description: 'JWT auth token',
|
|
4188
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
4189
|
+
},
|
|
4190
|
+
accessToken: {
|
|
4191
|
+
type: 'string',
|
|
4192
|
+
description: 'Auto-generated access token'
|
|
4193
|
+
},
|
|
4194
|
+
role: {
|
|
4195
|
+
type: 'string',
|
|
4196
|
+
description: 'Assigned user role',
|
|
4197
|
+
enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
|
|
4198
|
+
}
|
|
4199
|
+
},
|
|
4200
|
+
required: ['authToken', 'accessToken', 'role']
|
|
4201
|
+
} as const;
|
|
4202
|
+
|
|
4203
|
+
export const $UpdateUserSettingDto = {
|
|
4204
|
+
type: 'object',
|
|
4205
|
+
properties: {
|
|
4206
|
+
secId: {
|
|
4207
|
+
type: 'number',
|
|
4208
|
+
description: 'Security ID'
|
|
4209
|
+
},
|
|
4210
|
+
annualInterestRate: {
|
|
4211
|
+
type: 'number',
|
|
4212
|
+
description: 'Annual interest rate',
|
|
4213
|
+
example: 0.05
|
|
4214
|
+
},
|
|
4215
|
+
currency: {
|
|
4216
|
+
type: 'string',
|
|
4217
|
+
description: 'Currency code',
|
|
4218
|
+
example: 'USD'
|
|
4219
|
+
},
|
|
4220
|
+
baseCurrency: {
|
|
4221
|
+
type: 'string',
|
|
4222
|
+
description: 'Base currency code',
|
|
4223
|
+
example: 'USD'
|
|
4224
|
+
},
|
|
4225
|
+
benchmark: {
|
|
4226
|
+
type: 'string',
|
|
4227
|
+
description: 'Benchmark symbol',
|
|
4228
|
+
example: 'SPY'
|
|
4229
|
+
},
|
|
4230
|
+
colorScheme: {
|
|
4231
|
+
type: 'string',
|
|
4232
|
+
description: 'Color scheme',
|
|
4233
|
+
enum: ['DARK', 'LIGHT']
|
|
4234
|
+
},
|
|
4235
|
+
dateRange: {
|
|
4236
|
+
type: 'string',
|
|
4237
|
+
description: 'Date range filter',
|
|
4238
|
+
example: '1y'
|
|
4239
|
+
},
|
|
4240
|
+
emergencyFund: {
|
|
4241
|
+
type: 'number',
|
|
4242
|
+
description: 'Emergency fund amount',
|
|
4243
|
+
example: 10000
|
|
4244
|
+
},
|
|
4245
|
+
'filters.accounts': {
|
|
4246
|
+
description: 'Account filter IDs',
|
|
4247
|
+
type: 'array',
|
|
4248
|
+
items: {
|
|
4249
|
+
type: 'string'
|
|
4250
|
+
}
|
|
4251
|
+
},
|
|
4252
|
+
'filters.assetClasses': {
|
|
4253
|
+
description: 'Asset class filters',
|
|
4254
|
+
type: 'array',
|
|
4255
|
+
items: {
|
|
4256
|
+
type: 'string'
|
|
4257
|
+
}
|
|
4258
|
+
},
|
|
4259
|
+
'filters.dataSource': {
|
|
4260
|
+
type: 'string',
|
|
4261
|
+
description: 'Data source filter'
|
|
4262
|
+
},
|
|
4263
|
+
'filters.symbol': {
|
|
4264
|
+
type: 'string',
|
|
4265
|
+
description: 'Symbol filter'
|
|
4266
|
+
},
|
|
4267
|
+
'filters.tags': {
|
|
4268
|
+
description: 'Tag filters',
|
|
4269
|
+
type: 'array',
|
|
4270
|
+
items: {
|
|
4271
|
+
type: 'string'
|
|
4272
|
+
}
|
|
4273
|
+
},
|
|
4274
|
+
isExperimentalFeatures: {
|
|
4275
|
+
type: 'boolean',
|
|
4276
|
+
description: 'Enable experimental features'
|
|
4277
|
+
},
|
|
4278
|
+
isRestrictedView: {
|
|
4279
|
+
type: 'boolean',
|
|
4280
|
+
description: 'Enable restricted view mode'
|
|
4281
|
+
},
|
|
4282
|
+
language: {
|
|
4283
|
+
type: 'string',
|
|
4284
|
+
description: 'Language code',
|
|
4285
|
+
example: 'en'
|
|
4286
|
+
},
|
|
4287
|
+
locale: {
|
|
4288
|
+
type: 'string',
|
|
4289
|
+
description: 'Locale code',
|
|
4290
|
+
example: 'en-US'
|
|
4291
|
+
},
|
|
4292
|
+
projectedTotalAmount: {
|
|
4293
|
+
type: 'number',
|
|
4294
|
+
description: 'Projected total amount',
|
|
4295
|
+
example: 1000000
|
|
4296
|
+
},
|
|
4297
|
+
retirementDate: {
|
|
4298
|
+
type: 'string',
|
|
4299
|
+
description: 'Retirement date in ISO 8601 format',
|
|
4300
|
+
example: '2050-01-01'
|
|
4301
|
+
},
|
|
4302
|
+
savingsRate: {
|
|
4303
|
+
type: 'number',
|
|
4304
|
+
description: 'Savings rate percentage',
|
|
4305
|
+
example: 0.2
|
|
4306
|
+
},
|
|
4307
|
+
viewMode: {
|
|
4308
|
+
type: 'string',
|
|
4309
|
+
description: 'View mode',
|
|
4310
|
+
enum: ['DEFAULT', 'ZEN']
|
|
4311
|
+
}
|
|
4312
|
+
}
|
|
4313
|
+
} as const;
|
|
4314
|
+
|
|
4315
|
+
export const $UpdatePropertyDto = {
|
|
4316
|
+
type: 'object',
|
|
4317
|
+
properties: {
|
|
4318
|
+
value: {
|
|
4319
|
+
type: 'string',
|
|
4320
|
+
description: 'Property value'
|
|
4321
|
+
}
|
|
4322
|
+
},
|
|
4323
|
+
required: ['value']
|
|
4324
|
+
} as const;
|
|
4325
|
+
|
|
4326
|
+
export const $CreateTransactionRuleDto = {
|
|
4327
|
+
type: 'object',
|
|
4328
|
+
properties: {
|
|
4329
|
+
name: {
|
|
4330
|
+
type: 'string',
|
|
4331
|
+
minLength: 1,
|
|
4332
|
+
maxLength: 100
|
|
4333
|
+
},
|
|
4334
|
+
description: {
|
|
4335
|
+
type: 'string',
|
|
4336
|
+
maxLength: 500
|
|
4337
|
+
},
|
|
4338
|
+
narrationKeywords: {
|
|
4339
|
+
items: {
|
|
4340
|
+
type: 'array'
|
|
4341
|
+
},
|
|
4342
|
+
maxItems: 50,
|
|
4343
|
+
type: 'array'
|
|
4344
|
+
},
|
|
4345
|
+
payeeKeywords: {
|
|
4346
|
+
items: {
|
|
4347
|
+
type: 'array'
|
|
4348
|
+
},
|
|
4349
|
+
maxItems: 50,
|
|
4350
|
+
type: 'array'
|
|
4351
|
+
},
|
|
4352
|
+
categoryKeywords: {
|
|
4353
|
+
items: {
|
|
4354
|
+
type: 'array'
|
|
4355
|
+
},
|
|
4356
|
+
maxItems: 50,
|
|
4357
|
+
type: 'array'
|
|
4358
|
+
},
|
|
4359
|
+
methodKeywords: {
|
|
4360
|
+
items: {
|
|
4361
|
+
type: 'array'
|
|
4362
|
+
},
|
|
4363
|
+
maxItems: 50,
|
|
4364
|
+
description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
|
|
4365
|
+
type: 'array'
|
|
4366
|
+
},
|
|
4367
|
+
categoryAccount: {
|
|
4368
|
+
type: 'string',
|
|
4369
|
+
maxLength: 200,
|
|
4370
|
+
description:
|
|
4371
|
+
'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
|
|
4372
|
+
},
|
|
4373
|
+
matchLogic: {
|
|
4374
|
+
type: 'string',
|
|
4375
|
+
enum: ['OR', 'AND'],
|
|
4376
|
+
default: 'OR'
|
|
4377
|
+
},
|
|
4378
|
+
amountMin: {
|
|
4379
|
+
type: 'number',
|
|
4380
|
+
minimum: 0,
|
|
4381
|
+
description: 'Minimum transaction amount (inclusive)'
|
|
4382
|
+
},
|
|
4383
|
+
amountMax: {
|
|
4384
|
+
type: 'number',
|
|
4385
|
+
minimum: 0,
|
|
4386
|
+
description: 'Maximum transaction amount (inclusive)'
|
|
4387
|
+
},
|
|
4388
|
+
priority: {
|
|
4389
|
+
type: 'number',
|
|
4390
|
+
default: 50,
|
|
4391
|
+
minimum: 0,
|
|
4392
|
+
maximum: 1000
|
|
4393
|
+
},
|
|
4394
|
+
additionalTags: {
|
|
4395
|
+
items: {
|
|
4396
|
+
type: 'array'
|
|
4397
|
+
},
|
|
4398
|
+
maxItems: 20,
|
|
4399
|
+
type: 'array'
|
|
4400
|
+
},
|
|
4401
|
+
additionalMetadata: {
|
|
4402
|
+
type: 'object'
|
|
4403
|
+
},
|
|
4404
|
+
upsertByPayee: {
|
|
4405
|
+
type: 'boolean',
|
|
4406
|
+
description:
|
|
4407
|
+
'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
|
|
4408
|
+
}
|
|
4409
|
+
},
|
|
4410
|
+
required: ['name', 'matchLogic', 'priority']
|
|
4411
|
+
} as const;
|
|
4412
|
+
|
|
4413
|
+
export const $AmountRangeDto = {
|
|
4414
|
+
type: 'object',
|
|
4415
|
+
properties: {
|
|
4416
|
+
min: {
|
|
4417
|
+
type: 'number',
|
|
4418
|
+
description: 'Minimum amount'
|
|
4419
|
+
},
|
|
4420
|
+
max: {
|
|
4421
|
+
type: 'number',
|
|
4422
|
+
description: 'Maximum amount'
|
|
4423
|
+
}
|
|
4424
|
+
}
|
|
4425
|
+
} as const;
|
|
4426
|
+
|
|
4427
|
+
export const $TransactionRuleResponseDto = {
|
|
4428
|
+
type: 'object',
|
|
4429
|
+
properties: {
|
|
4430
|
+
id: {
|
|
4431
|
+
type: 'string',
|
|
4432
|
+
description: 'Rule ID'
|
|
4433
|
+
},
|
|
4434
|
+
name: {
|
|
4435
|
+
type: 'string',
|
|
4436
|
+
description: 'Rule name'
|
|
4437
|
+
},
|
|
4438
|
+
description: {
|
|
4439
|
+
type: 'string',
|
|
4440
|
+
description: 'Rule description'
|
|
3502
4441
|
},
|
|
3503
4442
|
narrationKeywords: {
|
|
3504
4443
|
description: 'Keywords to match in transaction narration',
|
|
@@ -4033,151 +4972,456 @@ export const $TestRuleResponseDto = {
|
|
|
4033
4972
|
required: ['ruleId', 'matches', 'confidence', 'matchDetails']
|
|
4034
4973
|
} as const;
|
|
4035
4974
|
|
|
4036
|
-
export const $
|
|
4975
|
+
export const $CategoryCatalogEntryDto = {
|
|
4037
4976
|
type: 'object',
|
|
4038
4977
|
properties: {
|
|
4039
|
-
|
|
4978
|
+
slug: {
|
|
4040
4979
|
type: 'string',
|
|
4041
|
-
description: '
|
|
4042
|
-
example: '
|
|
4980
|
+
description: 'Category slug (single source-of-truth)',
|
|
4981
|
+
example: 'food'
|
|
4982
|
+
},
|
|
4983
|
+
scenario: {
|
|
4984
|
+
type: 'string',
|
|
4985
|
+
description: 'Display scenario group (maps to frontend picker _scenario)',
|
|
4986
|
+
enum: [
|
|
4987
|
+
'expense',
|
|
4988
|
+
'income',
|
|
4989
|
+
'investment',
|
|
4990
|
+
'banking',
|
|
4991
|
+
'transfer',
|
|
4992
|
+
'payment'
|
|
4993
|
+
],
|
|
4994
|
+
example: 'expense'
|
|
4995
|
+
},
|
|
4996
|
+
icon: {
|
|
4997
|
+
type: 'string',
|
|
4998
|
+
description: 'Lucide icon name',
|
|
4999
|
+
example: 'utensils'
|
|
5000
|
+
},
|
|
5001
|
+
regions: {
|
|
5002
|
+
description: "Applicable regions ('*' = all, 'cn' = CN-only)",
|
|
5003
|
+
example: ['*'],
|
|
5004
|
+
type: 'array',
|
|
5005
|
+
items: {
|
|
5006
|
+
type: 'string'
|
|
5007
|
+
}
|
|
4043
5008
|
}
|
|
4044
5009
|
},
|
|
4045
|
-
required: ['
|
|
5010
|
+
required: ['slug', 'scenario', 'icon', 'regions']
|
|
4046
5011
|
} as const;
|
|
4047
5012
|
|
|
4048
|
-
export const $
|
|
5013
|
+
export const $CategoryCatalogListResponseDto = {
|
|
4049
5014
|
type: 'object',
|
|
4050
5015
|
properties: {
|
|
4051
|
-
|
|
5016
|
+
items: {
|
|
5017
|
+
description: 'Category entries (region-scoped, query-filtered)',
|
|
5018
|
+
type: 'array',
|
|
5019
|
+
items: {
|
|
5020
|
+
$ref: '#/components/schemas/CategoryCatalogEntryDto'
|
|
5021
|
+
}
|
|
5022
|
+
},
|
|
5023
|
+
total: {
|
|
5024
|
+
type: 'number',
|
|
5025
|
+
description:
|
|
5026
|
+
'Total category entries for the region (before query filtering)',
|
|
5027
|
+
example: 30
|
|
5028
|
+
},
|
|
5029
|
+
region: {
|
|
5030
|
+
type: 'string',
|
|
5031
|
+
description: 'Region code',
|
|
5032
|
+
example: 'cn'
|
|
5033
|
+
}
|
|
5034
|
+
},
|
|
5035
|
+
required: ['items', 'total', 'region']
|
|
5036
|
+
} as const;
|
|
5037
|
+
|
|
5038
|
+
export const $CreateBeanEventDto = {
|
|
5039
|
+
type: 'object',
|
|
5040
|
+
properties: {
|
|
5041
|
+
date: {
|
|
5042
|
+
type: 'string',
|
|
5043
|
+
description: 'Life event date (ISO 8601)',
|
|
5044
|
+
example: '2024-03-15'
|
|
5045
|
+
},
|
|
5046
|
+
type: {
|
|
4052
5047
|
type: 'string',
|
|
4053
5048
|
description:
|
|
4054
|
-
'
|
|
4055
|
-
example: '
|
|
5049
|
+
'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
|
|
5050
|
+
example: 'employer'
|
|
5051
|
+
},
|
|
5052
|
+
description: {
|
|
5053
|
+
type: 'string',
|
|
5054
|
+
description:
|
|
5055
|
+
'Life event description. Empty string is a VALID value (distinct from absence).',
|
|
5056
|
+
example: 'Acme Corp'
|
|
5057
|
+
},
|
|
5058
|
+
meta: {
|
|
5059
|
+
type: 'object',
|
|
5060
|
+
description:
|
|
5061
|
+
'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
|
|
5062
|
+
example: {
|
|
5063
|
+
note: 'Promotion'
|
|
5064
|
+
}
|
|
4056
5065
|
}
|
|
4057
|
-
}
|
|
5066
|
+
},
|
|
5067
|
+
required: ['date', 'type', 'description']
|
|
4058
5068
|
} as const;
|
|
4059
5069
|
|
|
4060
|
-
export const $
|
|
5070
|
+
export const $EventResponseDto = {
|
|
4061
5071
|
type: 'object',
|
|
4062
5072
|
properties: {
|
|
4063
|
-
|
|
4064
|
-
type: '
|
|
4065
|
-
description: '
|
|
5073
|
+
id: {
|
|
5074
|
+
type: 'string',
|
|
5075
|
+
description: 'Unique identifier',
|
|
5076
|
+
example: 'uuid-123-456'
|
|
4066
5077
|
},
|
|
4067
|
-
|
|
5078
|
+
userId: {
|
|
5079
|
+
type: 'string',
|
|
5080
|
+
description: 'User ID (owner of the life event)',
|
|
5081
|
+
example: 'user-123'
|
|
5082
|
+
},
|
|
5083
|
+
date: {
|
|
5084
|
+
type: 'string',
|
|
5085
|
+
description: 'Life event date (ISO 8601 format)',
|
|
5086
|
+
example: '2024-03-15',
|
|
5087
|
+
format: 'date'
|
|
5088
|
+
},
|
|
5089
|
+
type: {
|
|
5090
|
+
type: 'string',
|
|
5091
|
+
description:
|
|
5092
|
+
'Life event type (user-defined, e.g., "employer", "location")',
|
|
5093
|
+
example: 'employer'
|
|
5094
|
+
},
|
|
5095
|
+
description: {
|
|
5096
|
+
type: 'string',
|
|
5097
|
+
description:
|
|
5098
|
+
'Life event description. May be an empty string (a valid value distinct from absence).',
|
|
5099
|
+
example: 'Acme Corp'
|
|
5100
|
+
},
|
|
5101
|
+
meta: {
|
|
5102
|
+
type: 'object',
|
|
5103
|
+
description: 'Product-side metadata (free-form JSON)',
|
|
5104
|
+
example: {
|
|
5105
|
+
note: 'Promotion'
|
|
5106
|
+
}
|
|
5107
|
+
},
|
|
5108
|
+
createdAt: {
|
|
5109
|
+
format: 'date-time',
|
|
5110
|
+
type: 'string',
|
|
5111
|
+
description: 'Creation timestamp',
|
|
5112
|
+
example: '2024-03-15T10:00:00Z'
|
|
5113
|
+
},
|
|
5114
|
+
updatedAt: {
|
|
5115
|
+
format: 'date-time',
|
|
5116
|
+
type: 'string',
|
|
5117
|
+
description:
|
|
5118
|
+
'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
|
|
5119
|
+
example: '2024-03-15T10:00:00Z'
|
|
5120
|
+
}
|
|
5121
|
+
},
|
|
5122
|
+
required: [
|
|
5123
|
+
'id',
|
|
5124
|
+
'userId',
|
|
5125
|
+
'date',
|
|
5126
|
+
'type',
|
|
5127
|
+
'description',
|
|
5128
|
+
'meta',
|
|
5129
|
+
'createdAt',
|
|
5130
|
+
'updatedAt'
|
|
5131
|
+
]
|
|
5132
|
+
} as const;
|
|
5133
|
+
|
|
5134
|
+
export const $EventListResponseDto = {
|
|
5135
|
+
type: 'object',
|
|
5136
|
+
properties: {
|
|
5137
|
+
items: {
|
|
5138
|
+
description: 'List of life events',
|
|
5139
|
+
type: 'array',
|
|
5140
|
+
items: {
|
|
5141
|
+
$ref: '#/components/schemas/EventResponseDto'
|
|
5142
|
+
}
|
|
5143
|
+
},
|
|
5144
|
+
total: {
|
|
4068
5145
|
type: 'number',
|
|
4069
|
-
description: '
|
|
4070
|
-
example:
|
|
5146
|
+
description: 'Total number of life events matching the query',
|
|
5147
|
+
example: 42
|
|
5148
|
+
}
|
|
5149
|
+
},
|
|
5150
|
+
required: ['items', 'total']
|
|
5151
|
+
} as const;
|
|
5152
|
+
|
|
5153
|
+
export const $UpdateBeanEventDto = {
|
|
5154
|
+
type: 'object',
|
|
5155
|
+
properties: {
|
|
5156
|
+
date: {
|
|
5157
|
+
type: 'string',
|
|
5158
|
+
description: 'Life event date (ISO 8601)'
|
|
5159
|
+
},
|
|
5160
|
+
type: {
|
|
5161
|
+
type: 'string',
|
|
5162
|
+
description: 'Life event type (user-defined)'
|
|
5163
|
+
},
|
|
5164
|
+
description: {
|
|
5165
|
+
type: 'string',
|
|
5166
|
+
description:
|
|
5167
|
+
'Life event description. Empty string is a VALID value (distinct from absence).'
|
|
5168
|
+
},
|
|
5169
|
+
meta: {
|
|
5170
|
+
type: 'object',
|
|
5171
|
+
description: 'Product-side metadata (free-form JSON)'
|
|
5172
|
+
}
|
|
5173
|
+
}
|
|
5174
|
+
} as const;
|
|
5175
|
+
|
|
5176
|
+
export const $OnboardingAccountDto = {
|
|
5177
|
+
type: 'object',
|
|
5178
|
+
properties: {
|
|
5179
|
+
path: {
|
|
5180
|
+
type: 'string',
|
|
5181
|
+
description:
|
|
5182
|
+
'Account path (Assets/Liabilities only; format validated by the account service)',
|
|
5183
|
+
example: 'Assets:Checking'
|
|
4071
5184
|
},
|
|
4072
5185
|
currency: {
|
|
4073
5186
|
type: 'string',
|
|
4074
|
-
description: '
|
|
5187
|
+
description: 'ISO 4217 currency code (3 letters)',
|
|
4075
5188
|
example: 'USD'
|
|
4076
5189
|
},
|
|
4077
|
-
|
|
5190
|
+
openingBalance: {
|
|
5191
|
+
type: 'string',
|
|
5192
|
+
description:
|
|
5193
|
+
'Opening balance as a non-negative Decimal string (e.g. "1000.00")',
|
|
5194
|
+
example: '1000.00'
|
|
5195
|
+
},
|
|
5196
|
+
platformId: {
|
|
5197
|
+
type: 'string',
|
|
5198
|
+
description:
|
|
5199
|
+
'Platform ID to bind the account to (references Platform.id); omit for unbound',
|
|
5200
|
+
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
5201
|
+
}
|
|
5202
|
+
},
|
|
5203
|
+
required: ['path', 'currency']
|
|
5204
|
+
} as const;
|
|
5205
|
+
|
|
5206
|
+
export const $OnboardingDto = {
|
|
5207
|
+
type: 'object',
|
|
5208
|
+
properties: {
|
|
5209
|
+
accounts: {
|
|
5210
|
+
description: 'Asset/Liability accounts to register with opening balances',
|
|
5211
|
+
type: 'array',
|
|
5212
|
+
items: {
|
|
5213
|
+
$ref: '#/components/schemas/OnboardingAccountDto'
|
|
5214
|
+
}
|
|
5215
|
+
},
|
|
5216
|
+
skipAssetRegistration: {
|
|
5217
|
+
type: 'boolean',
|
|
5218
|
+
description:
|
|
5219
|
+
'Skip asset registration; only bootstrap the core account set',
|
|
5220
|
+
default: false
|
|
5221
|
+
}
|
|
5222
|
+
}
|
|
5223
|
+
} as const;
|
|
5224
|
+
|
|
5225
|
+
export const $ActualBalanceDto = {
|
|
5226
|
+
type: 'object',
|
|
5227
|
+
properties: {
|
|
5228
|
+
amount: {
|
|
5229
|
+
type: 'string',
|
|
5230
|
+
description:
|
|
5231
|
+
'Actual balance amount as a decimal string (preserves precision for tolerance inference).',
|
|
5232
|
+
example: '1234.56'
|
|
5233
|
+
},
|
|
5234
|
+
ccy: {
|
|
5235
|
+
type: 'string',
|
|
5236
|
+
description: 'Currency code (ISO 4217 or commodity ticker).',
|
|
5237
|
+
example: 'CNY'
|
|
5238
|
+
}
|
|
5239
|
+
},
|
|
5240
|
+
required: ['amount', 'ccy']
|
|
5241
|
+
} as const;
|
|
5242
|
+
|
|
5243
|
+
export const $ComputeReconciliationDto = {
|
|
5244
|
+
type: 'object',
|
|
5245
|
+
properties: {
|
|
5246
|
+
accountId: {
|
|
5247
|
+
type: 'string',
|
|
5248
|
+
description: 'BeanAccount id to reconcile.'
|
|
5249
|
+
},
|
|
5250
|
+
asOfDate: {
|
|
5251
|
+
type: 'string',
|
|
5252
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5253
|
+
example: '2026-07-24'
|
|
5254
|
+
},
|
|
5255
|
+
actualBalance: {
|
|
5256
|
+
description: 'Actual balance from the external statement.',
|
|
5257
|
+
allOf: [
|
|
5258
|
+
{
|
|
5259
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5260
|
+
}
|
|
5261
|
+
]
|
|
5262
|
+
}
|
|
5263
|
+
},
|
|
5264
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5265
|
+
} as const;
|
|
5266
|
+
|
|
5267
|
+
export const $ReconciliationComputeResultDto = {
|
|
5268
|
+
type: 'object',
|
|
5269
|
+
properties: {
|
|
5270
|
+
accountId: {
|
|
5271
|
+
type: 'string'
|
|
5272
|
+
},
|
|
5273
|
+
asOfDate: {
|
|
5274
|
+
type: 'string'
|
|
5275
|
+
},
|
|
5276
|
+
bookBalance: {
|
|
5277
|
+
type: 'string',
|
|
5278
|
+
description: 'System-computed book balance (decimal string).'
|
|
5279
|
+
},
|
|
5280
|
+
actualBalance: {
|
|
5281
|
+
type: 'string',
|
|
5282
|
+
description: 'User-entered actual balance (decimal string).'
|
|
5283
|
+
},
|
|
5284
|
+
currency: {
|
|
5285
|
+
type: 'string'
|
|
5286
|
+
},
|
|
5287
|
+
diff: {
|
|
5288
|
+
type: 'string',
|
|
5289
|
+
description: 'Diff = book − actual (decimal string).'
|
|
5290
|
+
},
|
|
5291
|
+
tolerance: {
|
|
5292
|
+
type: 'string',
|
|
5293
|
+
description: 'Applied tolerance (decimal string).'
|
|
5294
|
+
},
|
|
5295
|
+
withinTolerance: {
|
|
5296
|
+
type: 'boolean',
|
|
5297
|
+
description: 'true when |diff| ≤ tolerance.'
|
|
5298
|
+
},
|
|
5299
|
+
suggestedAction: {
|
|
5300
|
+
type: 'string',
|
|
5301
|
+
enum: ['assert', 'pad'],
|
|
5302
|
+
description:
|
|
5303
|
+
'Suggested next action: assert when within tolerance, pad otherwise.'
|
|
5304
|
+
}
|
|
5305
|
+
},
|
|
5306
|
+
required: [
|
|
5307
|
+
'accountId',
|
|
5308
|
+
'asOfDate',
|
|
5309
|
+
'bookBalance',
|
|
5310
|
+
'actualBalance',
|
|
5311
|
+
'currency',
|
|
5312
|
+
'diff',
|
|
5313
|
+
'tolerance',
|
|
5314
|
+
'withinTolerance',
|
|
5315
|
+
'suggestedAction'
|
|
5316
|
+
]
|
|
5317
|
+
} as const;
|
|
5318
|
+
|
|
5319
|
+
export const $AssertReconciliationDto = {
|
|
5320
|
+
type: 'object',
|
|
5321
|
+
properties: {
|
|
5322
|
+
accountId: {
|
|
4078
5323
|
type: 'string',
|
|
4079
|
-
description: '
|
|
4080
|
-
example: 'USD'
|
|
5324
|
+
description: 'BeanAccount id to reconcile.'
|
|
4081
5325
|
},
|
|
4082
|
-
|
|
5326
|
+
asOfDate: {
|
|
4083
5327
|
type: 'string',
|
|
4084
|
-
description: '
|
|
4085
|
-
example: '
|
|
5328
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5329
|
+
example: '2026-07-24'
|
|
4086
5330
|
},
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
|
|
4090
|
-
|
|
5331
|
+
actualBalance: {
|
|
5332
|
+
description: 'Actual balance from the external statement.',
|
|
5333
|
+
allOf: [
|
|
5334
|
+
{
|
|
5335
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5336
|
+
}
|
|
5337
|
+
]
|
|
4091
5338
|
},
|
|
4092
|
-
|
|
5339
|
+
tolerance: {
|
|
4093
5340
|
type: 'string',
|
|
4094
|
-
description:
|
|
4095
|
-
|
|
4096
|
-
|
|
4097
|
-
|
|
4098
|
-
|
|
4099
|
-
|
|
4100
|
-
|
|
4101
|
-
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
|
|
4105
|
-
|
|
4106
|
-
|
|
4107
|
-
}
|
|
5341
|
+
description:
|
|
5342
|
+
'Optional explicit tolerance override. Omit to infer from amount precision (Beancount default).',
|
|
5343
|
+
example: '0.01'
|
|
5344
|
+
}
|
|
5345
|
+
},
|
|
5346
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
5347
|
+
} as const;
|
|
5348
|
+
|
|
5349
|
+
export const $ReconciliationRecordDto = {
|
|
5350
|
+
type: 'object',
|
|
5351
|
+
properties: {
|
|
5352
|
+
id: {
|
|
5353
|
+
type: 'string'
|
|
4108
5354
|
},
|
|
4109
|
-
|
|
4110
|
-
|
|
4111
|
-
type: 'array',
|
|
4112
|
-
items: {
|
|
4113
|
-
type: 'string'
|
|
4114
|
-
}
|
|
5355
|
+
accountId: {
|
|
5356
|
+
type: 'string'
|
|
4115
5357
|
},
|
|
4116
|
-
|
|
4117
|
-
type: 'string'
|
|
4118
|
-
description: 'Data source filter'
|
|
5358
|
+
date: {
|
|
5359
|
+
type: 'string'
|
|
4119
5360
|
},
|
|
4120
|
-
|
|
5361
|
+
amount: {
|
|
4121
5362
|
type: 'string',
|
|
4122
|
-
description: '
|
|
4123
|
-
},
|
|
4124
|
-
'filters.tags': {
|
|
4125
|
-
description: 'Tag filters',
|
|
4126
|
-
type: 'array',
|
|
4127
|
-
items: {
|
|
4128
|
-
type: 'string'
|
|
4129
|
-
}
|
|
5363
|
+
description: 'Asserted (actual) amount.'
|
|
4130
5364
|
},
|
|
4131
|
-
|
|
4132
|
-
type: '
|
|
4133
|
-
description: 'Enable experimental features'
|
|
5365
|
+
currency: {
|
|
5366
|
+
type: 'string'
|
|
4134
5367
|
},
|
|
4135
|
-
|
|
4136
|
-
type: '
|
|
4137
|
-
description: 'Enable restricted view mode'
|
|
5368
|
+
tolerance: {
|
|
5369
|
+
type: 'string'
|
|
4138
5370
|
},
|
|
4139
|
-
|
|
5371
|
+
diffAmount: {
|
|
4140
5372
|
type: 'string',
|
|
4141
|
-
description: '
|
|
4142
|
-
example: 'en'
|
|
5373
|
+
description: 'book − actual.'
|
|
4143
5374
|
},
|
|
4144
|
-
|
|
4145
|
-
type: 'string'
|
|
4146
|
-
description: 'Locale code',
|
|
4147
|
-
example: 'en-US'
|
|
5375
|
+
diffCurrency: {
|
|
5376
|
+
type: 'string'
|
|
4148
5377
|
},
|
|
4149
|
-
|
|
4150
|
-
type: '
|
|
4151
|
-
|
|
4152
|
-
|
|
5378
|
+
createdAt: {
|
|
5379
|
+
type: 'string'
|
|
5380
|
+
}
|
|
5381
|
+
},
|
|
5382
|
+
required: ['id', 'accountId', 'date', 'amount', 'currency', 'createdAt']
|
|
5383
|
+
} as const;
|
|
5384
|
+
|
|
5385
|
+
export const $PadReconciliationDto = {
|
|
5386
|
+
type: 'object',
|
|
5387
|
+
properties: {
|
|
5388
|
+
accountId: {
|
|
5389
|
+
type: 'string',
|
|
5390
|
+
description: 'BeanAccount id to reconcile.'
|
|
4153
5391
|
},
|
|
4154
|
-
|
|
5392
|
+
asOfDate: {
|
|
4155
5393
|
type: 'string',
|
|
4156
|
-
description: '
|
|
4157
|
-
example: '
|
|
5394
|
+
description: 'Assertion date (ISO 8601, e.g. "2026-07-24").',
|
|
5395
|
+
example: '2026-07-24'
|
|
4158
5396
|
},
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
|
|
4162
|
-
|
|
5397
|
+
actualBalance: {
|
|
5398
|
+
description: 'Actual balance from the external statement.',
|
|
5399
|
+
allOf: [
|
|
5400
|
+
{
|
|
5401
|
+
$ref: '#/components/schemas/ActualBalanceDto'
|
|
5402
|
+
}
|
|
5403
|
+
]
|
|
4163
5404
|
},
|
|
4164
|
-
|
|
5405
|
+
sourceAccount: {
|
|
4165
5406
|
type: 'string',
|
|
4166
|
-
description:
|
|
4167
|
-
|
|
5407
|
+
description:
|
|
5408
|
+
'Pad source account. Defaults to Equity:Opening-Balances (official Beancount convention).',
|
|
5409
|
+
example: 'Equity:Opening-Balances',
|
|
5410
|
+
default: 'Equity:Opening-Balances'
|
|
4168
5411
|
}
|
|
4169
|
-
}
|
|
5412
|
+
},
|
|
5413
|
+
required: ['accountId', 'asOfDate', 'actualBalance']
|
|
4170
5414
|
} as const;
|
|
4171
5415
|
|
|
4172
|
-
export const $
|
|
5416
|
+
export const $PadResultDto = {
|
|
4173
5417
|
type: 'object',
|
|
4174
5418
|
properties: {
|
|
4175
|
-
|
|
5419
|
+
transactionId: {
|
|
4176
5420
|
type: 'string',
|
|
4177
|
-
description: '
|
|
5421
|
+
description: 'Created pad adjusting transaction id.'
|
|
4178
5422
|
}
|
|
4179
5423
|
},
|
|
4180
|
-
required: ['
|
|
5424
|
+
required: ['transactionId']
|
|
4181
5425
|
} as const;
|
|
4182
5426
|
|
|
4183
5427
|
export const $FileImportDto = {
|
|
@@ -4346,7 +5590,7 @@ export const $IdentifyResultDto = {
|
|
|
4346
5590
|
account: {
|
|
4347
5591
|
type: 'string',
|
|
4348
5592
|
description: 'Default account used by this importer',
|
|
4349
|
-
example: 'Assets:Alipay:Balance'
|
|
5593
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4350
5594
|
},
|
|
4351
5595
|
message: {
|
|
4352
5596
|
type: 'string',
|
|
@@ -4363,7 +5607,7 @@ export const $MapperDefaultsDto = {
|
|
|
4363
5607
|
sourceAccount: {
|
|
4364
5608
|
type: 'string',
|
|
4365
5609
|
description: 'Source account for transactions (Beancount format)',
|
|
4366
|
-
example: 'Assets:Alipay:Balance'
|
|
5610
|
+
example: 'Assets:CN:Alipay:Balance'
|
|
4367
5611
|
},
|
|
4368
5612
|
currency: {
|
|
4369
5613
|
type: 'string',
|
|
@@ -4400,7 +5644,7 @@ export const $MapperDefaultsDto = {
|
|
|
4400
5644
|
description:
|
|
4401
5645
|
'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
5646
|
example: {
|
|
4403
|
-
HuaBei: 'Liabilities:
|
|
5647
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
4404
5648
|
CreditCard: 'Liabilities:CreditCard'
|
|
4405
5649
|
}
|
|
4406
5650
|
}
|
|
@@ -4523,180 +5767,77 @@ export const $ImporterConfigDto = {
|
|
|
4523
5767
|
'config',
|
|
4524
5768
|
'createdAt',
|
|
4525
5769
|
'updatedAt'
|
|
4526
|
-
]
|
|
4527
|
-
} as const;
|
|
4528
|
-
|
|
4529
|
-
export const $UpdateMapperDefaultsDto = {
|
|
4530
|
-
type: 'object',
|
|
4531
|
-
properties: {
|
|
4532
|
-
sourceAccount: {
|
|
4533
|
-
type: 'string',
|
|
4534
|
-
description: 'Source account for transactions (Beancount format)',
|
|
4535
|
-
example: 'Assets:Alipay:Balance',
|
|
4536
|
-
pattern:
|
|
4537
|
-
|
|
4538
|
-
currency: {
|
|
4539
|
-
type: 'string',
|
|
4540
|
-
description: 'Default currency (ISO 4217 code)',
|
|
4541
|
-
example: 'CNY',
|
|
4542
|
-
minLength: 3,
|
|
4543
|
-
maxLength: 3,
|
|
4544
|
-
pattern: '^[A-Z]{3}$'
|
|
4545
|
-
},
|
|
4546
|
-
expenseAccount: {
|
|
4547
|
-
type: 'string',
|
|
4548
|
-
description: 'Default expense account (optional)',
|
|
4549
|
-
example: 'Expenses:Unknown',
|
|
4550
|
-
pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
|
|
4551
|
-
},
|
|
4552
|
-
incomeAccount: {
|
|
4553
|
-
type: 'string',
|
|
4554
|
-
description: 'Default income account (optional)',
|
|
4555
|
-
example: 'Income:Unknown',
|
|
4556
|
-
pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
|
|
4557
|
-
},
|
|
4558
|
-
methodAccountMapping: {
|
|
4559
|
-
type: 'object',
|
|
4560
|
-
description:
|
|
4561
|
-
'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
|
-
example: {
|
|
4563
|
-
HuaBei: 'Liabilities:Alipay:Huabei',
|
|
4564
|
-
CreditCard: 'Liabilities:CreditCard'
|
|
4565
|
-
}
|
|
4566
|
-
}
|
|
4567
|
-
}
|
|
4568
|
-
} as const;
|
|
4569
|
-
|
|
4570
|
-
export const $UpdateConfigDataDto = {
|
|
4571
|
-
type: 'object',
|
|
4572
|
-
properties: {
|
|
4573
|
-
defaults: {
|
|
4574
|
-
description: 'Mapper defaults configuration',
|
|
4575
|
-
allOf: [
|
|
4576
|
-
{
|
|
4577
|
-
$ref: '#/components/schemas/UpdateMapperDefaultsDto'
|
|
4578
|
-
}
|
|
4579
|
-
]
|
|
4580
|
-
}
|
|
4581
|
-
}
|
|
4582
|
-
} as const;
|
|
4583
|
-
|
|
4584
|
-
export const $UpdateImporterConfigDto = {
|
|
4585
|
-
type: 'object',
|
|
4586
|
-
properties: {
|
|
4587
|
-
data: {
|
|
4588
|
-
description: 'Configuration data (v1 schema)',
|
|
4589
|
-
allOf: [
|
|
4590
|
-
{
|
|
4591
|
-
$ref: '#/components/schemas/UpdateConfigDataDto'
|
|
4592
|
-
}
|
|
4593
|
-
]
|
|
4594
|
-
}
|
|
4595
|
-
}
|
|
4596
|
-
} as const;
|
|
4597
|
-
|
|
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
|
-
}
|
|
5770
|
+
]
|
|
5771
|
+
} as const;
|
|
5772
|
+
|
|
5773
|
+
export const $UpdateMapperDefaultsDto = {
|
|
5774
|
+
type: 'object',
|
|
5775
|
+
properties: {
|
|
5776
|
+
sourceAccount: {
|
|
5777
|
+
type: 'string',
|
|
5778
|
+
description: 'Source account for transactions (Beancount format)',
|
|
5779
|
+
example: 'Assets:CN:Alipay:Balance',
|
|
5780
|
+
pattern:
|
|
5781
|
+
'^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
|
|
4672
5782
|
},
|
|
4673
|
-
|
|
5783
|
+
currency: {
|
|
4674
5784
|
type: 'string',
|
|
4675
|
-
description: '
|
|
4676
|
-
example: '
|
|
5785
|
+
description: 'Default currency (ISO 4217 code)',
|
|
5786
|
+
example: 'CNY',
|
|
5787
|
+
minLength: 3,
|
|
5788
|
+
maxLength: 3,
|
|
5789
|
+
pattern: '^[A-Z]{3}$'
|
|
4677
5790
|
},
|
|
4678
|
-
|
|
5791
|
+
expenseAccount: {
|
|
4679
5792
|
type: 'string',
|
|
4680
|
-
description: '
|
|
4681
|
-
|
|
4682
|
-
|
|
4683
|
-
'
|
|
4684
|
-
'CRYPTO_EXCHANGE',
|
|
4685
|
-
'PAYMENT',
|
|
4686
|
-
'INVESTMENT',
|
|
4687
|
-
'INSURANCE',
|
|
4688
|
-
'OTHER'
|
|
4689
|
-
],
|
|
4690
|
-
example: 'CRYPTO_EXCHANGE'
|
|
5793
|
+
description: 'Default expense account (optional)',
|
|
5794
|
+
example: 'Expenses:Unknown',
|
|
5795
|
+
pattern:
|
|
5796
|
+
'^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
|
|
4691
5797
|
},
|
|
4692
|
-
|
|
5798
|
+
incomeAccount: {
|
|
4693
5799
|
type: 'string',
|
|
4694
|
-
description: '
|
|
4695
|
-
example: '
|
|
5800
|
+
description: 'Default income account (optional)',
|
|
5801
|
+
example: 'Income:Unknown',
|
|
5802
|
+
pattern:
|
|
5803
|
+
'^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
|
|
4696
5804
|
},
|
|
4697
|
-
|
|
4698
|
-
type: '
|
|
4699
|
-
description:
|
|
5805
|
+
methodAccountMapping: {
|
|
5806
|
+
type: 'object',
|
|
5807
|
+
description:
|
|
5808
|
+
'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).',
|
|
5809
|
+
example: {
|
|
5810
|
+
HuaBei: 'Liabilities:CN:CreditLine',
|
|
5811
|
+
CreditCard: 'Liabilities:CreditCard'
|
|
5812
|
+
}
|
|
5813
|
+
}
|
|
5814
|
+
}
|
|
5815
|
+
} as const;
|
|
5816
|
+
|
|
5817
|
+
export const $UpdateConfigDataDto = {
|
|
5818
|
+
type: 'object',
|
|
5819
|
+
properties: {
|
|
5820
|
+
defaults: {
|
|
5821
|
+
description: 'Mapper defaults configuration',
|
|
5822
|
+
allOf: [
|
|
5823
|
+
{
|
|
5824
|
+
$ref: '#/components/schemas/UpdateMapperDefaultsDto'
|
|
5825
|
+
}
|
|
5826
|
+
]
|
|
5827
|
+
}
|
|
5828
|
+
}
|
|
5829
|
+
} as const;
|
|
5830
|
+
|
|
5831
|
+
export const $UpdateImporterConfigDto = {
|
|
5832
|
+
type: 'object',
|
|
5833
|
+
properties: {
|
|
5834
|
+
data: {
|
|
5835
|
+
description: 'Configuration data (v1 schema)',
|
|
5836
|
+
allOf: [
|
|
5837
|
+
{
|
|
5838
|
+
$ref: '#/components/schemas/UpdateConfigDataDto'
|
|
5839
|
+
}
|
|
5840
|
+
]
|
|
4700
5841
|
}
|
|
4701
5842
|
}
|
|
4702
5843
|
} as const;
|
|
@@ -4707,7 +5848,7 @@ export const $ProviderSyncConfigDto = {
|
|
|
4707
5848
|
sourceAccount: {
|
|
4708
5849
|
type: 'string',
|
|
4709
5850
|
description: 'Source account for the first posting',
|
|
4710
|
-
example: 'Assets:
|
|
5851
|
+
example: 'Assets:US:Chase:Checking'
|
|
4711
5852
|
},
|
|
4712
5853
|
defaultCurrency: {
|
|
4713
5854
|
type: 'string',
|
|
@@ -4716,26 +5857,29 @@ export const $ProviderSyncConfigDto = {
|
|
|
4716
5857
|
},
|
|
4717
5858
|
defaultExpenseAccount: {
|
|
4718
5859
|
type: 'string',
|
|
4719
|
-
description:
|
|
5860
|
+
description:
|
|
5861
|
+
'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
|
|
4720
5862
|
example: 'Expenses:Unknown'
|
|
4721
5863
|
},
|
|
4722
5864
|
defaultIncomeAccount: {
|
|
4723
5865
|
type: 'string',
|
|
4724
|
-
description:
|
|
5866
|
+
description:
|
|
5867
|
+
'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
|
|
4725
5868
|
example: 'Income:Unknown'
|
|
4726
5869
|
},
|
|
4727
5870
|
filterPending: {
|
|
4728
5871
|
type: 'boolean',
|
|
4729
5872
|
description: 'Filter pending transactions',
|
|
4730
5873
|
default: true
|
|
5874
|
+
},
|
|
5875
|
+
externalAccountId: {
|
|
5876
|
+
type: 'string',
|
|
5877
|
+
description:
|
|
5878
|
+
'External account ID for per-batch providers (e.g. GoCardless). Overrides sourceAccount when an ExternalAccountLink mapping exists.',
|
|
5879
|
+
example: 'acc_gocardless_001'
|
|
4731
5880
|
}
|
|
4732
5881
|
},
|
|
4733
|
-
required: [
|
|
4734
|
-
'sourceAccount',
|
|
4735
|
-
'defaultCurrency',
|
|
4736
|
-
'defaultExpenseAccount',
|
|
4737
|
-
'defaultIncomeAccount'
|
|
4738
|
-
]
|
|
5882
|
+
required: ['sourceAccount', 'defaultCurrency']
|
|
4739
5883
|
} as const;
|
|
4740
5884
|
|
|
4741
5885
|
export const $ProviderSyncDto = {
|
|
@@ -4811,45 +5955,221 @@ export const $ProviderSyncResponseDto = {
|
|
|
4811
5955
|
type: 'string'
|
|
4812
5956
|
}
|
|
4813
5957
|
},
|
|
4814
|
-
reviewItemIds: {
|
|
4815
|
-
description: 'IDs of review items created for branched transactions',
|
|
4816
|
-
example: ['review-001', 'review-002'],
|
|
4817
|
-
type: 'array',
|
|
4818
|
-
items: {
|
|
4819
|
-
type: 'string'
|
|
4820
|
-
}
|
|
4821
|
-
}
|
|
4822
|
-
},
|
|
4823
|
-
required: ['imported', 'skipped', 'pendingReview', 'failed']
|
|
4824
|
-
} as const;
|
|
4825
|
-
|
|
4826
|
-
export const $SupportedProvidersResponseDto = {
|
|
4827
|
-
type: 'object',
|
|
4828
|
-
properties: {
|
|
4829
|
-
providers: {
|
|
4830
|
-
description: 'List of supported provider names',
|
|
4831
|
-
example: [
|
|
4832
|
-
'plaid',
|
|
4833
|
-
'teller',
|
|
4834
|
-
'truelayer',
|
|
4835
|
-
'gocardless',
|
|
4836
|
-
'simplefin',
|
|
4837
|
-
'yodlee',
|
|
4838
|
-
'beancount-direct',
|
|
4839
|
-
'parsed-bill'
|
|
4840
|
-
],
|
|
4841
|
-
type: 'array',
|
|
4842
|
-
items: {
|
|
4843
|
-
type: 'string'
|
|
4844
|
-
}
|
|
5958
|
+
reviewItemIds: {
|
|
5959
|
+
description: 'IDs of review items created for branched transactions',
|
|
5960
|
+
example: ['review-001', 'review-002'],
|
|
5961
|
+
type: 'array',
|
|
5962
|
+
items: {
|
|
5963
|
+
type: 'string'
|
|
5964
|
+
}
|
|
5965
|
+
}
|
|
5966
|
+
},
|
|
5967
|
+
required: ['imported', 'skipped', 'pendingReview', 'failed']
|
|
5968
|
+
} as const;
|
|
5969
|
+
|
|
5970
|
+
export const $SupportedProvidersResponseDto = {
|
|
5971
|
+
type: 'object',
|
|
5972
|
+
properties: {
|
|
5973
|
+
providers: {
|
|
5974
|
+
description: 'List of supported provider names',
|
|
5975
|
+
example: [
|
|
5976
|
+
'plaid',
|
|
5977
|
+
'teller',
|
|
5978
|
+
'truelayer',
|
|
5979
|
+
'gocardless',
|
|
5980
|
+
'simplefin',
|
|
5981
|
+
'yodlee',
|
|
5982
|
+
'beancount-direct',
|
|
5983
|
+
'parsed-bill'
|
|
5984
|
+
],
|
|
5985
|
+
type: 'array',
|
|
5986
|
+
items: {
|
|
5987
|
+
type: 'string'
|
|
5988
|
+
}
|
|
5989
|
+
}
|
|
5990
|
+
},
|
|
5991
|
+
required: ['providers']
|
|
5992
|
+
} as const;
|
|
5993
|
+
|
|
5994
|
+
export const $CreateExternalAccountLinkDto = {
|
|
5995
|
+
type: 'object',
|
|
5996
|
+
properties: {
|
|
5997
|
+
provider: {
|
|
5998
|
+
type: 'string',
|
|
5999
|
+
enum: [
|
|
6000
|
+
'plaid',
|
|
6001
|
+
'teller',
|
|
6002
|
+
'truelayer',
|
|
6003
|
+
'gocardless',
|
|
6004
|
+
'simplefin',
|
|
6005
|
+
'yodlee',
|
|
6006
|
+
'beancount-direct',
|
|
6007
|
+
'parsed-bill'
|
|
6008
|
+
],
|
|
6009
|
+
example: 'plaid',
|
|
6010
|
+
description: 'Open Banking provider (whitelist)'
|
|
6011
|
+
},
|
|
6012
|
+
externalAccountId: {
|
|
6013
|
+
type: 'string',
|
|
6014
|
+
example: 'acc-plaid-001',
|
|
6015
|
+
description: 'External account ID from the provider'
|
|
6016
|
+
},
|
|
6017
|
+
beanAccountId: {
|
|
6018
|
+
type: 'string',
|
|
6019
|
+
example: '550e8400-e29b-41d4-a716-446655440000',
|
|
6020
|
+
description: 'Target BeanAccount ID (must belong to the JWT user)'
|
|
6021
|
+
}
|
|
6022
|
+
},
|
|
6023
|
+
required: ['provider', 'externalAccountId', 'beanAccountId']
|
|
6024
|
+
} as const;
|
|
6025
|
+
|
|
6026
|
+
export const $ExternalAccountLinkResponseDto = {
|
|
6027
|
+
type: 'object',
|
|
6028
|
+
properties: {
|
|
6029
|
+
id: {
|
|
6030
|
+
type: 'string'
|
|
6031
|
+
},
|
|
6032
|
+
provider: {
|
|
6033
|
+
type: 'string'
|
|
6034
|
+
},
|
|
6035
|
+
externalAccountId: {
|
|
6036
|
+
type: 'string'
|
|
6037
|
+
},
|
|
6038
|
+
beanAccountId: {
|
|
6039
|
+
type: 'string'
|
|
6040
|
+
},
|
|
6041
|
+
isActive: {
|
|
6042
|
+
type: 'boolean'
|
|
6043
|
+
},
|
|
6044
|
+
createdAt: {
|
|
6045
|
+
type: 'string'
|
|
6046
|
+
},
|
|
6047
|
+
updatedAt: {
|
|
6048
|
+
type: 'string'
|
|
6049
|
+
}
|
|
6050
|
+
},
|
|
6051
|
+
required: [
|
|
6052
|
+
'id',
|
|
6053
|
+
'provider',
|
|
6054
|
+
'externalAccountId',
|
|
6055
|
+
'beanAccountId',
|
|
6056
|
+
'isActive',
|
|
6057
|
+
'createdAt',
|
|
6058
|
+
'updatedAt'
|
|
6059
|
+
]
|
|
6060
|
+
} as const;
|
|
6061
|
+
|
|
6062
|
+
export const $ExternalAccountLinkListResponseDto = {
|
|
6063
|
+
type: 'object',
|
|
6064
|
+
properties: {
|
|
6065
|
+
items: {
|
|
6066
|
+
type: 'array',
|
|
6067
|
+
items: {
|
|
6068
|
+
$ref: '#/components/schemas/ExternalAccountLinkResponseDto'
|
|
6069
|
+
}
|
|
6070
|
+
},
|
|
6071
|
+
total: {
|
|
6072
|
+
type: 'number'
|
|
6073
|
+
},
|
|
6074
|
+
provider: {
|
|
6075
|
+
type: 'string',
|
|
6076
|
+
description: 'Filter by provider (query param)'
|
|
6077
|
+
}
|
|
6078
|
+
},
|
|
6079
|
+
required: ['items', 'total']
|
|
6080
|
+
} as const;
|
|
6081
|
+
|
|
6082
|
+
export const $ParserTelemetryReportDto = {
|
|
6083
|
+
type: 'object',
|
|
6084
|
+
properties: {}
|
|
6085
|
+
} as const;
|
|
6086
|
+
|
|
6087
|
+
export const $UncoveredFormatMissDto = {
|
|
6088
|
+
type: 'object',
|
|
6089
|
+
properties: {}
|
|
6090
|
+
} as const;
|
|
6091
|
+
|
|
6092
|
+
export const $ClientParsedDataDto = {
|
|
6093
|
+
type: 'object',
|
|
6094
|
+
properties: {
|
|
6095
|
+
amount: {
|
|
6096
|
+
type: 'number',
|
|
6097
|
+
description: 'Transaction amount',
|
|
6098
|
+
example: 35
|
|
6099
|
+
},
|
|
6100
|
+
currency: {
|
|
6101
|
+
type: 'string',
|
|
6102
|
+
description: 'Currency code',
|
|
6103
|
+
example: 'CNY'
|
|
6104
|
+
},
|
|
6105
|
+
date: {
|
|
6106
|
+
type: 'string',
|
|
6107
|
+
description: 'Transaction date (ISO 8601)',
|
|
6108
|
+
example: '2026-08-15'
|
|
6109
|
+
},
|
|
6110
|
+
payee: {
|
|
6111
|
+
type: 'string',
|
|
6112
|
+
description: 'Payee/merchant name',
|
|
6113
|
+
example: 'Starbucks'
|
|
6114
|
+
},
|
|
6115
|
+
narration: {
|
|
6116
|
+
type: 'string',
|
|
6117
|
+
description: 'Transaction narration'
|
|
6118
|
+
},
|
|
6119
|
+
category: {
|
|
6120
|
+
type: 'string',
|
|
6121
|
+
description: 'Category slug',
|
|
6122
|
+
example: 'food_restaurant'
|
|
6123
|
+
},
|
|
6124
|
+
incomeType: {
|
|
6125
|
+
type: 'string',
|
|
6126
|
+
description: 'Income type',
|
|
6127
|
+
example: 'Salary'
|
|
6128
|
+
},
|
|
6129
|
+
incomeSource: {
|
|
6130
|
+
type: 'string',
|
|
6131
|
+
description: 'Income source',
|
|
6132
|
+
example: 'Anthropic Inc.'
|
|
6133
|
+
},
|
|
6134
|
+
symbol: {
|
|
6135
|
+
type: 'string',
|
|
6136
|
+
description: 'Security symbol code (e.g., 600519, AAPL)',
|
|
6137
|
+
example: 'AAPL'
|
|
6138
|
+
},
|
|
6139
|
+
quantity: {
|
|
6140
|
+
type: 'number',
|
|
6141
|
+
description: 'Quantity of shares/units',
|
|
6142
|
+
example: 100
|
|
6143
|
+
},
|
|
6144
|
+
price: {
|
|
6145
|
+
type: 'number',
|
|
6146
|
+
description: 'Unit price per share/unit',
|
|
6147
|
+
example: 1900
|
|
6148
|
+
},
|
|
6149
|
+
investmentAction: {
|
|
6150
|
+
type: 'string',
|
|
6151
|
+
description: 'Investment action',
|
|
6152
|
+
enum: ['buy', 'sell'],
|
|
6153
|
+
example: 'buy'
|
|
6154
|
+
},
|
|
6155
|
+
paymentSource: {
|
|
6156
|
+
type: 'string',
|
|
6157
|
+
description: 'Payment source: asset (default) or liability (credit card)',
|
|
6158
|
+
enum: ['asset', 'liability'],
|
|
6159
|
+
example: 'asset'
|
|
6160
|
+
},
|
|
6161
|
+
liabilityHint: {
|
|
6162
|
+
type: 'string',
|
|
6163
|
+
description: 'Liability account hint (CreditCard/Huabei/Baitiao)',
|
|
6164
|
+
example: 'CreditCard'
|
|
6165
|
+
},
|
|
6166
|
+
warning: {
|
|
6167
|
+
type: 'string',
|
|
6168
|
+
description:
|
|
6169
|
+
'Display-only warning from the prior response; accepted but ignored.',
|
|
6170
|
+
example: 'Cross-currency settlement applies.'
|
|
4845
6171
|
}
|
|
4846
|
-
}
|
|
4847
|
-
required: ['providers']
|
|
4848
|
-
} as const;
|
|
4849
|
-
|
|
4850
|
-
export const $ParserTelemetryReportDto = {
|
|
4851
|
-
type: 'object',
|
|
4852
|
-
properties: {}
|
|
6172
|
+
}
|
|
4853
6173
|
} as const;
|
|
4854
6174
|
|
|
4855
6175
|
export const $ProcessNlpDto = {
|
|
@@ -4857,10 +6177,17 @@ export const $ProcessNlpDto = {
|
|
|
4857
6177
|
properties: {
|
|
4858
6178
|
message: {
|
|
4859
6179
|
type: 'string',
|
|
4860
|
-
description:
|
|
4861
|
-
|
|
6180
|
+
description:
|
|
6181
|
+
'Natural language text describing a transaction. Optional when `confirm` is true (structured confirm); otherwise required.',
|
|
6182
|
+
example: 'Starbucks 35',
|
|
4862
6183
|
maxLength: 500
|
|
4863
6184
|
},
|
|
6185
|
+
confirm: {
|
|
6186
|
+
type: 'boolean',
|
|
6187
|
+
description:
|
|
6188
|
+
'Structured confirm signal — bypasses NL confirm-word matching when true. Send parsedData field edits alongside. The NL word-list path is the fallback.',
|
|
6189
|
+
example: true
|
|
6190
|
+
},
|
|
4864
6191
|
sessionId: {
|
|
4865
6192
|
type: 'string',
|
|
4866
6193
|
description:
|
|
@@ -4868,17 +6195,32 @@ export const $ProcessNlpDto = {
|
|
|
4868
6195
|
example: 'session_abc123'
|
|
4869
6196
|
},
|
|
4870
6197
|
parsedData: {
|
|
4871
|
-
type: 'object',
|
|
4872
6198
|
description:
|
|
4873
6199
|
'Parsed data from previous NLP response for session recovery. Send back the parsedData received in confirm_payee/confirm responses.',
|
|
4874
6200
|
example: {
|
|
4875
6201
|
amount: 35,
|
|
4876
6202
|
currency: 'CNY',
|
|
4877
6203
|
payee: 'Starbucks'
|
|
4878
|
-
}
|
|
6204
|
+
},
|
|
6205
|
+
allOf: [
|
|
6206
|
+
{
|
|
6207
|
+
$ref: '#/components/schemas/ClientParsedDataDto'
|
|
6208
|
+
}
|
|
6209
|
+
]
|
|
6210
|
+
},
|
|
6211
|
+
selectedRuleId: {
|
|
6212
|
+
type: 'string',
|
|
6213
|
+
description:
|
|
6214
|
+
'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.',
|
|
6215
|
+
example: 'rule_abc123'
|
|
6216
|
+
},
|
|
6217
|
+
selectedAccount: {
|
|
6218
|
+
type: 'string',
|
|
6219
|
+
description:
|
|
6220
|
+
'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.',
|
|
6221
|
+
example: 'Expenses:Food:Coffee'
|
|
4879
6222
|
}
|
|
4880
|
-
}
|
|
4881
|
-
required: ['message']
|
|
6223
|
+
}
|
|
4882
6224
|
} as const;
|
|
4883
6225
|
|
|
4884
6226
|
export const $NlpTransactionInfoDto = {
|
|
@@ -5200,7 +6542,8 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5200
6542
|
},
|
|
5201
6543
|
suggestedAccount: {
|
|
5202
6544
|
type: 'string',
|
|
5203
|
-
description:
|
|
6545
|
+
description:
|
|
6546
|
+
'Suggested replacement account (omitted when no clear candidate)',
|
|
5204
6547
|
example: 'Expenses:Food:Drinks'
|
|
5205
6548
|
},
|
|
5206
6549
|
similarAccounts: {
|
|
@@ -5222,7 +6565,6 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
5222
6565
|
},
|
|
5223
6566
|
required: [
|
|
5224
6567
|
'invalidAccount',
|
|
5225
|
-
'suggestedAccount',
|
|
5226
6568
|
'similarAccounts',
|
|
5227
6569
|
'errorMessage',
|
|
5228
6570
|
'transactionContext'
|
|
@@ -5391,11 +6733,12 @@ export const $NlpSuggestedAccountDto = {
|
|
|
5391
6733
|
account: {
|
|
5392
6734
|
type: 'string',
|
|
5393
6735
|
description: 'Suggested account path',
|
|
5394
|
-
example: 'Assets:
|
|
6736
|
+
example: 'Assets:Checking'
|
|
5395
6737
|
},
|
|
5396
6738
|
confidence: {
|
|
5397
6739
|
type: 'number',
|
|
5398
|
-
description:
|
|
6740
|
+
description:
|
|
6741
|
+
'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
|
|
5399
6742
|
example: 0.9
|
|
5400
6743
|
}
|
|
5401
6744
|
},
|
|
@@ -5431,23 +6774,31 @@ export const $NlpDefaultAccountsDto = {
|
|
|
5431
6774
|
properties: {
|
|
5432
6775
|
asset: {
|
|
5433
6776
|
type: 'string',
|
|
5434
|
-
description:
|
|
5435
|
-
|
|
6777
|
+
description:
|
|
6778
|
+
'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
|
|
6779
|
+
example: 'Assets:Checking',
|
|
6780
|
+
nullable: true
|
|
5436
6781
|
},
|
|
5437
6782
|
expense: {
|
|
5438
6783
|
type: 'string',
|
|
5439
|
-
description:
|
|
5440
|
-
|
|
6784
|
+
description:
|
|
6785
|
+
'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
|
|
6786
|
+
example: 'Expenses:Food:Coffee',
|
|
6787
|
+
nullable: true
|
|
5441
6788
|
},
|
|
5442
6789
|
income: {
|
|
5443
6790
|
type: 'string',
|
|
5444
|
-
description:
|
|
5445
|
-
|
|
6791
|
+
description:
|
|
6792
|
+
'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
|
|
6793
|
+
example: 'Income:Salary',
|
|
6794
|
+
nullable: true
|
|
5446
6795
|
},
|
|
5447
6796
|
liability: {
|
|
5448
6797
|
type: 'string',
|
|
5449
|
-
description:
|
|
5450
|
-
|
|
6798
|
+
description:
|
|
6799
|
+
'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
|
|
6800
|
+
example: 'Liabilities:CreditCard',
|
|
6801
|
+
nullable: true
|
|
5451
6802
|
}
|
|
5452
6803
|
},
|
|
5453
6804
|
required: ['asset', 'expense', 'income', 'liability']
|
|
@@ -5472,7 +6823,8 @@ export const $NlpResponseDto = {
|
|
|
5472
6823
|
'confirm_rule',
|
|
5473
6824
|
'confirm_account',
|
|
5474
6825
|
'confirm_payee',
|
|
5475
|
-
'cancel'
|
|
6826
|
+
'cancel',
|
|
6827
|
+
'aborted'
|
|
5476
6828
|
]
|
|
5477
6829
|
},
|
|
5478
6830
|
intent: {
|
|
@@ -5486,7 +6838,7 @@ export const $NlpResponseDto = {
|
|
|
5486
6838
|
type: 'string',
|
|
5487
6839
|
description:
|
|
5488
6840
|
'Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.',
|
|
5489
|
-
enum: ['transfer', 'banking', 'investment'],
|
|
6841
|
+
enum: ['transfer', 'banking', 'investment', 'lend', 'lend_collect'],
|
|
5490
6842
|
example: 'investment'
|
|
5491
6843
|
},
|
|
5492
6844
|
liabilitySubType: {
|
|
@@ -5632,43 +6984,304 @@ export const $NlpResponseDto = {
|
|
|
5632
6984
|
}
|
|
5633
6985
|
]
|
|
5634
6986
|
},
|
|
5635
|
-
suggestedAccounts: {
|
|
5636
|
-
description:
|
|
5637
|
-
'Suggested accounts for this transaction.
|
|
5638
|
-
allOf: [
|
|
5639
|
-
{
|
|
5640
|
-
$ref: '#/components/schemas/NlpSuggestedAccountsDto'
|
|
5641
|
-
}
|
|
5642
|
-
]
|
|
6987
|
+
suggestedAccounts: {
|
|
6988
|
+
description:
|
|
6989
|
+
'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.',
|
|
6990
|
+
allOf: [
|
|
6991
|
+
{
|
|
6992
|
+
$ref: '#/components/schemas/NlpSuggestedAccountsDto'
|
|
6993
|
+
}
|
|
6994
|
+
]
|
|
6995
|
+
},
|
|
6996
|
+
defaultAccounts: {
|
|
6997
|
+
description:
|
|
6998
|
+
'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
|
|
6999
|
+
allOf: [
|
|
7000
|
+
{
|
|
7001
|
+
$ref: '#/components/schemas/NlpDefaultAccountsDto'
|
|
7002
|
+
}
|
|
7003
|
+
]
|
|
7004
|
+
}
|
|
7005
|
+
},
|
|
7006
|
+
required: ['status', 'action']
|
|
7007
|
+
} as const;
|
|
7008
|
+
|
|
7009
|
+
export const $PlatformListItemDto = {
|
|
7010
|
+
type: 'object',
|
|
7011
|
+
properties: {
|
|
7012
|
+
id: {
|
|
7013
|
+
type: 'string',
|
|
7014
|
+
description: 'Global platform ID'
|
|
7015
|
+
},
|
|
7016
|
+
name: {
|
|
7017
|
+
type: 'string',
|
|
7018
|
+
description: 'Platform name'
|
|
7019
|
+
},
|
|
7020
|
+
url: {
|
|
7021
|
+
type: 'string',
|
|
7022
|
+
description: 'Platform URL'
|
|
7023
|
+
},
|
|
7024
|
+
type: {
|
|
7025
|
+
type: 'string',
|
|
7026
|
+
description: 'Platform type',
|
|
7027
|
+
enum: [
|
|
7028
|
+
'BANK',
|
|
7029
|
+
'BROKERAGE',
|
|
7030
|
+
'CRYPTO_EXCHANGE',
|
|
7031
|
+
'PAYMENT',
|
|
7032
|
+
'INVESTMENT',
|
|
7033
|
+
'INSURANCE',
|
|
7034
|
+
'OTHER'
|
|
7035
|
+
]
|
|
7036
|
+
},
|
|
7037
|
+
canonical: {
|
|
7038
|
+
type: 'string',
|
|
7039
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
7040
|
+
},
|
|
7041
|
+
suggestedSegment: {
|
|
7042
|
+
type: 'string',
|
|
7043
|
+
description:
|
|
7044
|
+
'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
|
|
7045
|
+
},
|
|
7046
|
+
logoUrl: {
|
|
7047
|
+
type: 'string',
|
|
7048
|
+
description: 'Logo URL',
|
|
7049
|
+
nullable: true
|
|
7050
|
+
},
|
|
7051
|
+
countryCode: {
|
|
7052
|
+
type: 'string',
|
|
7053
|
+
description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
|
|
7054
|
+
example: 'CN',
|
|
7055
|
+
nullable: true
|
|
7056
|
+
},
|
|
7057
|
+
category: {
|
|
7058
|
+
type: 'string',
|
|
7059
|
+
description:
|
|
7060
|
+
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
|
|
7061
|
+
nullable: true,
|
|
7062
|
+
example: 'DigitalWallet'
|
|
7063
|
+
},
|
|
7064
|
+
isBound: {
|
|
7065
|
+
type: 'boolean',
|
|
7066
|
+
description: 'Whether user has accounts using this platform'
|
|
7067
|
+
}
|
|
7068
|
+
},
|
|
7069
|
+
required: [
|
|
7070
|
+
'id',
|
|
7071
|
+
'name',
|
|
7072
|
+
'url',
|
|
7073
|
+
'type',
|
|
7074
|
+
'canonical',
|
|
7075
|
+
'suggestedSegment',
|
|
7076
|
+
'logoUrl',
|
|
7077
|
+
'countryCode',
|
|
7078
|
+
'category',
|
|
7079
|
+
'isBound'
|
|
7080
|
+
]
|
|
7081
|
+
} as const;
|
|
7082
|
+
|
|
7083
|
+
export const $PlatformMatchResultDto = {
|
|
7084
|
+
type: 'object',
|
|
7085
|
+
properties: {
|
|
7086
|
+
id: {
|
|
7087
|
+
type: 'string',
|
|
7088
|
+
description: 'Global platform ID'
|
|
7089
|
+
},
|
|
7090
|
+
name: {
|
|
7091
|
+
type: 'string',
|
|
7092
|
+
description: 'Platform name (e.g., "ICBC")'
|
|
7093
|
+
},
|
|
7094
|
+
canonical: {
|
|
7095
|
+
type: 'string',
|
|
7096
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
7097
|
+
},
|
|
7098
|
+
type: {
|
|
7099
|
+
type: 'string',
|
|
7100
|
+
description: 'Platform type',
|
|
7101
|
+
enum: [
|
|
7102
|
+
'BANK',
|
|
7103
|
+
'BROKERAGE',
|
|
7104
|
+
'CRYPTO_EXCHANGE',
|
|
7105
|
+
'PAYMENT',
|
|
7106
|
+
'INVESTMENT',
|
|
7107
|
+
'INSURANCE',
|
|
7108
|
+
'OTHER'
|
|
7109
|
+
]
|
|
7110
|
+
},
|
|
7111
|
+
suggestedSegment: {
|
|
7112
|
+
type: 'string',
|
|
7113
|
+
description:
|
|
7114
|
+
'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
|
|
7115
|
+
},
|
|
7116
|
+
logoUrl: {
|
|
7117
|
+
type: 'string',
|
|
7118
|
+
description: 'Logo URL',
|
|
7119
|
+
nullable: true
|
|
7120
|
+
},
|
|
7121
|
+
countryCode: {
|
|
7122
|
+
type: 'string',
|
|
7123
|
+
description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
|
|
7124
|
+
example: 'CN',
|
|
7125
|
+
nullable: true
|
|
7126
|
+
},
|
|
7127
|
+
category: {
|
|
7128
|
+
type: 'string',
|
|
7129
|
+
description:
|
|
7130
|
+
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
|
|
7131
|
+
nullable: true,
|
|
7132
|
+
example: 'DigitalWallet'
|
|
7133
|
+
},
|
|
7134
|
+
matchType: {
|
|
7135
|
+
type: 'string',
|
|
7136
|
+
description: "How this row matched: 'exact' > 'prefix' > 'substring'",
|
|
7137
|
+
enum: ['exact', 'prefix', 'substring']
|
|
7138
|
+
}
|
|
7139
|
+
},
|
|
7140
|
+
required: [
|
|
7141
|
+
'id',
|
|
7142
|
+
'name',
|
|
7143
|
+
'canonical',
|
|
7144
|
+
'type',
|
|
7145
|
+
'suggestedSegment',
|
|
7146
|
+
'logoUrl',
|
|
7147
|
+
'countryCode',
|
|
7148
|
+
'category',
|
|
7149
|
+
'matchType'
|
|
7150
|
+
]
|
|
7151
|
+
} as const;
|
|
7152
|
+
|
|
7153
|
+
export const $PlatformMatchResponseDto = {
|
|
7154
|
+
type: 'object',
|
|
7155
|
+
properties: {
|
|
7156
|
+
platforms: {
|
|
7157
|
+
description: 'Ranked matches, best tier first (at most 10 rows)',
|
|
7158
|
+
type: 'array',
|
|
7159
|
+
items: {
|
|
7160
|
+
$ref: '#/components/schemas/PlatformMatchResultDto'
|
|
7161
|
+
}
|
|
7162
|
+
},
|
|
7163
|
+
matchType: {
|
|
7164
|
+
type: 'string',
|
|
7165
|
+
description:
|
|
7166
|
+
"Overall match quality — top row's tier, or 'none' when no hits",
|
|
7167
|
+
enum: ['none', 'exact', 'prefix', 'substring']
|
|
7168
|
+
},
|
|
7169
|
+
total: {
|
|
7170
|
+
type: 'number',
|
|
7171
|
+
description: 'Total matches before LIMIT (truncation transparency)'
|
|
7172
|
+
},
|
|
7173
|
+
hasMore: {
|
|
7174
|
+
type: 'boolean',
|
|
7175
|
+
description: 'true when total > platforms.length (more matches exist)'
|
|
7176
|
+
}
|
|
7177
|
+
},
|
|
7178
|
+
required: ['platforms', 'matchType', 'total', 'hasMore']
|
|
7179
|
+
} as const;
|
|
7180
|
+
|
|
7181
|
+
export const $CreatePlatformDto = {
|
|
7182
|
+
type: 'object',
|
|
7183
|
+
properties: {
|
|
7184
|
+
name: {
|
|
7185
|
+
type: 'string',
|
|
7186
|
+
description: 'Platform name',
|
|
7187
|
+
example: 'Binance'
|
|
7188
|
+
},
|
|
7189
|
+
canonical: {
|
|
7190
|
+
type: 'string',
|
|
7191
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
7192
|
+
example: 'binance'
|
|
7193
|
+
},
|
|
7194
|
+
aliases: {
|
|
7195
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
7196
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
7197
|
+
type: 'array',
|
|
7198
|
+
items: {
|
|
7199
|
+
type: 'string'
|
|
7200
|
+
}
|
|
7201
|
+
},
|
|
7202
|
+
url: {
|
|
7203
|
+
type: 'string',
|
|
7204
|
+
description: 'Platform URL',
|
|
7205
|
+
example: 'https://www.binance.com'
|
|
7206
|
+
},
|
|
7207
|
+
type: {
|
|
7208
|
+
type: 'string',
|
|
7209
|
+
description: 'Platform type',
|
|
7210
|
+
enum: [
|
|
7211
|
+
'BANK',
|
|
7212
|
+
'BROKERAGE',
|
|
7213
|
+
'CRYPTO_EXCHANGE',
|
|
7214
|
+
'PAYMENT',
|
|
7215
|
+
'INVESTMENT',
|
|
7216
|
+
'INSURANCE',
|
|
7217
|
+
'OTHER'
|
|
7218
|
+
],
|
|
7219
|
+
example: 'CRYPTO_EXCHANGE'
|
|
7220
|
+
},
|
|
7221
|
+
logoUrl: {
|
|
7222
|
+
type: 'string',
|
|
7223
|
+
description: 'Platform logo URL',
|
|
7224
|
+
example: 'https://example.com/logos/binance.png'
|
|
5643
7225
|
},
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
{
|
|
5649
|
-
$ref: '#/components/schemas/NlpDefaultAccountsDto'
|
|
5650
|
-
}
|
|
5651
|
-
]
|
|
7226
|
+
isActive: {
|
|
7227
|
+
type: 'boolean',
|
|
7228
|
+
description: 'Whether the platform is active',
|
|
7229
|
+
default: true
|
|
5652
7230
|
}
|
|
5653
7231
|
},
|
|
5654
|
-
required: ['
|
|
7232
|
+
required: ['name', 'canonical', 'aliases', 'url', 'type']
|
|
5655
7233
|
} as const;
|
|
5656
7234
|
|
|
5657
|
-
export const $
|
|
7235
|
+
export const $UpdatePlatformDto = {
|
|
5658
7236
|
type: 'object',
|
|
5659
7237
|
properties: {
|
|
5660
|
-
|
|
7238
|
+
name: {
|
|
5661
7239
|
type: 'string',
|
|
5662
|
-
description: '
|
|
5663
|
-
example: '
|
|
7240
|
+
description: 'Platform name',
|
|
7241
|
+
example: 'Binance'
|
|
5664
7242
|
},
|
|
5665
|
-
|
|
7243
|
+
canonical: {
|
|
5666
7244
|
type: 'string',
|
|
5667
|
-
description: '
|
|
5668
|
-
example: '
|
|
7245
|
+
description: 'Platform canonical identifier (lowercase, kebab-case)',
|
|
7246
|
+
example: 'binance'
|
|
7247
|
+
},
|
|
7248
|
+
aliases: {
|
|
7249
|
+
description: 'Platform aliases (multi-language names for lookup)',
|
|
7250
|
+
example: ['Binance', 'Binance Exchange', 'BNB'],
|
|
7251
|
+
type: 'array',
|
|
7252
|
+
items: {
|
|
7253
|
+
type: 'string'
|
|
7254
|
+
}
|
|
7255
|
+
},
|
|
7256
|
+
url: {
|
|
7257
|
+
type: 'string',
|
|
7258
|
+
description: 'Platform URL',
|
|
7259
|
+
example: 'https://www.binance.com'
|
|
7260
|
+
},
|
|
7261
|
+
type: {
|
|
7262
|
+
type: 'string',
|
|
7263
|
+
description: 'Platform type',
|
|
7264
|
+
enum: [
|
|
7265
|
+
'BANK',
|
|
7266
|
+
'BROKERAGE',
|
|
7267
|
+
'CRYPTO_EXCHANGE',
|
|
7268
|
+
'PAYMENT',
|
|
7269
|
+
'INVESTMENT',
|
|
7270
|
+
'INSURANCE',
|
|
7271
|
+
'OTHER'
|
|
7272
|
+
],
|
|
7273
|
+
example: 'CRYPTO_EXCHANGE'
|
|
7274
|
+
},
|
|
7275
|
+
logoUrl: {
|
|
7276
|
+
type: 'string',
|
|
7277
|
+
description: 'Platform logo URL',
|
|
7278
|
+
example: 'https://example.com/logos/binance.png'
|
|
7279
|
+
},
|
|
7280
|
+
isActive: {
|
|
7281
|
+
type: 'boolean',
|
|
7282
|
+
description: 'Whether the platform is active'
|
|
5669
7283
|
}
|
|
5670
|
-
}
|
|
5671
|
-
required: ['currency', 'balance']
|
|
7284
|
+
}
|
|
5672
7285
|
} as const;
|
|
5673
7286
|
|
|
5674
7287
|
export const $NetWorthByCurrencyDto = {
|
|
@@ -5740,28 +7353,6 @@ export const $ConvertedNetWorthDto = {
|
|
|
5740
7353
|
]
|
|
5741
7354
|
} as const;
|
|
5742
7355
|
|
|
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
7356
|
export const $NetWorthResponseDto = {
|
|
5766
7357
|
type: 'object',
|
|
5767
7358
|
properties: {
|
|
@@ -5847,7 +7438,7 @@ export const $AccountItemDto = {
|
|
|
5847
7438
|
name: {
|
|
5848
7439
|
type: 'string',
|
|
5849
7440
|
description: 'Full account name',
|
|
5850
|
-
example: 'Assets:
|
|
7441
|
+
example: 'Assets:CN:CMB:Savings'
|
|
5851
7442
|
},
|
|
5852
7443
|
displayName: {
|
|
5853
7444
|
type: 'string',
|
|
@@ -5863,6 +7454,12 @@ export const $AccountItemDto = {
|
|
|
5863
7454
|
type: 'string',
|
|
5864
7455
|
description: 'Currency code',
|
|
5865
7456
|
example: 'CNY'
|
|
7457
|
+
},
|
|
7458
|
+
convertedBalance: {
|
|
7459
|
+
type: 'string',
|
|
7460
|
+
description:
|
|
7461
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7462
|
+
example: '50000.00'
|
|
5866
7463
|
}
|
|
5867
7464
|
},
|
|
5868
7465
|
required: ['id', 'name', 'displayName', 'balance', 'currency']
|
|
@@ -5889,11 +7486,66 @@ export const $PlatformGroupDto = {
|
|
|
5889
7486
|
},
|
|
5890
7487
|
totalBalance: {
|
|
5891
7488
|
type: 'string',
|
|
5892
|
-
description: '
|
|
7489
|
+
description: 'FX-converted total balance in base currency',
|
|
7490
|
+
example: '100000.00'
|
|
7491
|
+
},
|
|
7492
|
+
balanceByCurrency: {
|
|
7493
|
+
description: 'Raw (unconverted) balances grouped by currency',
|
|
7494
|
+
type: 'array',
|
|
7495
|
+
items: {
|
|
7496
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
7497
|
+
}
|
|
7498
|
+
},
|
|
7499
|
+
convertedBalance: {
|
|
7500
|
+
type: 'string',
|
|
7501
|
+
description:
|
|
7502
|
+
'Converted balance in base currency (omitted when no currency is convertible)',
|
|
5893
7503
|
example: '100000.00'
|
|
7504
|
+
},
|
|
7505
|
+
sharePct: {
|
|
7506
|
+
type: 'number',
|
|
7507
|
+
description:
|
|
7508
|
+
'Share of the grand converted total (0-100); 0 when grand total is 0',
|
|
7509
|
+
example: 42.5
|
|
7510
|
+
}
|
|
7511
|
+
},
|
|
7512
|
+
required: [
|
|
7513
|
+
'platformId',
|
|
7514
|
+
'platformName',
|
|
7515
|
+
'accounts',
|
|
7516
|
+
'totalBalance',
|
|
7517
|
+
'balanceByCurrency',
|
|
7518
|
+
'sharePct'
|
|
7519
|
+
]
|
|
7520
|
+
} as const;
|
|
7521
|
+
|
|
7522
|
+
export const $AccountExchangeRateWarningDto = {
|
|
7523
|
+
type: 'object',
|
|
7524
|
+
properties: {
|
|
7525
|
+
type: {
|
|
7526
|
+
type: 'string',
|
|
7527
|
+
description: 'Warning type',
|
|
7528
|
+
example: 'MISSING_EXCHANGE_RATE'
|
|
7529
|
+
},
|
|
7530
|
+
currency: {
|
|
7531
|
+
type: 'string',
|
|
7532
|
+
description: 'Currency without exchange rate',
|
|
7533
|
+
example: 'USD'
|
|
7534
|
+
},
|
|
7535
|
+
accounts: {
|
|
7536
|
+
description: 'Affected account paths',
|
|
7537
|
+
type: 'array',
|
|
7538
|
+
items: {
|
|
7539
|
+
type: 'string'
|
|
7540
|
+
}
|
|
7541
|
+
},
|
|
7542
|
+
totalAmount: {
|
|
7543
|
+
type: 'string',
|
|
7544
|
+
description: 'Total amount in this currency',
|
|
7545
|
+
example: '5000.00'
|
|
5894
7546
|
}
|
|
5895
7547
|
},
|
|
5896
|
-
required: ['
|
|
7548
|
+
required: ['type', 'currency', 'accounts', 'totalAmount']
|
|
5897
7549
|
} as const;
|
|
5898
7550
|
|
|
5899
7551
|
export const $AccountsSummaryDto = {
|
|
@@ -5906,9 +7558,21 @@ export const $AccountsSummaryDto = {
|
|
|
5906
7558
|
totalPlatforms: {
|
|
5907
7559
|
type: 'number',
|
|
5908
7560
|
description: 'Total number of platforms'
|
|
7561
|
+
},
|
|
7562
|
+
baseCurrency: {
|
|
7563
|
+
type: 'string',
|
|
7564
|
+
description: 'Base currency for conversion',
|
|
7565
|
+
example: 'CNY'
|
|
7566
|
+
},
|
|
7567
|
+
warnings: {
|
|
7568
|
+
description: 'Per-account exchange rate warnings',
|
|
7569
|
+
type: 'array',
|
|
7570
|
+
items: {
|
|
7571
|
+
$ref: '#/components/schemas/AccountExchangeRateWarningDto'
|
|
7572
|
+
}
|
|
5909
7573
|
}
|
|
5910
7574
|
},
|
|
5911
|
-
required: ['totalAccounts', 'totalPlatforms']
|
|
7575
|
+
required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
|
|
5912
7576
|
} as const;
|
|
5913
7577
|
|
|
5914
7578
|
export const $AccountsResponseDto = {
|
|
@@ -5943,7 +7607,7 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
5943
7607
|
name: {
|
|
5944
7608
|
type: 'string',
|
|
5945
7609
|
description: 'Full account name',
|
|
5946
|
-
example: 'Assets:
|
|
7610
|
+
example: 'Assets:CN:CMB:Savings'
|
|
5947
7611
|
},
|
|
5948
7612
|
displayName: {
|
|
5949
7613
|
type: 'string',
|
|
@@ -5960,6 +7624,12 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
5960
7624
|
description: 'Currency code',
|
|
5961
7625
|
example: 'CNY'
|
|
5962
7626
|
},
|
|
7627
|
+
convertedBalance: {
|
|
7628
|
+
type: 'string',
|
|
7629
|
+
description:
|
|
7630
|
+
'FX-converted balance in base currency; omitted when not convertible',
|
|
7631
|
+
example: '50000.00'
|
|
7632
|
+
},
|
|
5963
7633
|
assetClass: {
|
|
5964
7634
|
type: 'string',
|
|
5965
7635
|
description: 'Asset class',
|
|
@@ -5979,6 +7649,12 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
5979
7649
|
type: 'string',
|
|
5980
7650
|
description: 'Risk level',
|
|
5981
7651
|
example: 'LOW'
|
|
7652
|
+
},
|
|
7653
|
+
source: {
|
|
7654
|
+
type: 'string',
|
|
7655
|
+
description:
|
|
7656
|
+
'ADR-0105 classification provenance (holding level always; account level only on FALLBACK)',
|
|
7657
|
+
enum: ['USER_META', 'FIAT_CURRENCY', 'OPENBB_MAPPING', 'FALLBACK']
|
|
5982
7658
|
}
|
|
5983
7659
|
},
|
|
5984
7660
|
required: ['id', 'name', 'displayName', 'balance', 'currency', 'assetClass']
|
|
@@ -6033,82 +7709,154 @@ export const $AssetClassGroupDto = {
|
|
|
6033
7709
|
required: ['assetClass', 'accounts', 'balanceByCurrency']
|
|
6034
7710
|
} as const;
|
|
6035
7711
|
|
|
6036
|
-
export const $
|
|
7712
|
+
export const $AssetClassSummaryDto = {
|
|
6037
7713
|
type: 'object',
|
|
6038
7714
|
properties: {
|
|
6039
|
-
|
|
6040
|
-
type: '
|
|
6041
|
-
description: '
|
|
6042
|
-
example: 'MISSING_EXCHANGE_RATE'
|
|
7715
|
+
totalAccounts: {
|
|
7716
|
+
type: 'number',
|
|
7717
|
+
description: 'Total number of accounts'
|
|
6043
7718
|
},
|
|
6044
|
-
|
|
7719
|
+
totalAssetClasses: {
|
|
7720
|
+
type: 'number',
|
|
7721
|
+
description: 'Total number of asset classes'
|
|
7722
|
+
},
|
|
7723
|
+
baseCurrency: {
|
|
6045
7724
|
type: 'string',
|
|
6046
|
-
description: '
|
|
6047
|
-
example: '
|
|
7725
|
+
description: 'Base currency for conversion',
|
|
7726
|
+
example: 'CNY'
|
|
6048
7727
|
},
|
|
6049
|
-
|
|
6050
|
-
description: '
|
|
7728
|
+
warnings: {
|
|
7729
|
+
description: 'Exchange rate warnings',
|
|
6051
7730
|
type: 'array',
|
|
6052
7731
|
items: {
|
|
6053
|
-
|
|
7732
|
+
$ref: '#/components/schemas/AccountExchangeRateWarningDto'
|
|
6054
7733
|
}
|
|
6055
7734
|
},
|
|
6056
|
-
|
|
6057
|
-
type: '
|
|
6058
|
-
description:
|
|
6059
|
-
|
|
7735
|
+
fallback: {
|
|
7736
|
+
type: 'object',
|
|
7737
|
+
description:
|
|
7738
|
+
'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
7739
|
}
|
|
6061
7740
|
},
|
|
6062
|
-
required: ['
|
|
7741
|
+
required: ['totalAccounts', 'totalAssetClasses', 'baseCurrency']
|
|
6063
7742
|
} as const;
|
|
6064
7743
|
|
|
6065
|
-
export const $
|
|
7744
|
+
export const $AssetClassAccountsResponseDto = {
|
|
6066
7745
|
type: 'object',
|
|
6067
7746
|
properties: {
|
|
6068
|
-
|
|
6069
|
-
|
|
6070
|
-
|
|
7747
|
+
groups: {
|
|
7748
|
+
description: 'Account groups by asset class',
|
|
7749
|
+
type: 'array',
|
|
7750
|
+
items: {
|
|
7751
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7752
|
+
}
|
|
7753
|
+
},
|
|
7754
|
+
summary: {
|
|
7755
|
+
description: 'Summary statistics',
|
|
7756
|
+
allOf: [
|
|
7757
|
+
{
|
|
7758
|
+
$ref: '#/components/schemas/AssetClassSummaryDto'
|
|
7759
|
+
}
|
|
7760
|
+
]
|
|
7761
|
+
},
|
|
7762
|
+
uncategorized: {
|
|
7763
|
+
description:
|
|
7764
|
+
'ADR-0105 §6 holding-level grey-area bucket (source=FALLBACK holdings peeled out of groups). Present only for groupBy=holdingAssetClass when FALLBACK holdings exist.',
|
|
7765
|
+
allOf: [
|
|
7766
|
+
{
|
|
7767
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7768
|
+
}
|
|
7769
|
+
]
|
|
7770
|
+
}
|
|
7771
|
+
},
|
|
7772
|
+
required: ['groups', 'summary']
|
|
7773
|
+
} as const;
|
|
7774
|
+
|
|
7775
|
+
export const $HoldingAssetClassAccountSliceDto = {
|
|
7776
|
+
type: 'object',
|
|
7777
|
+
properties: {
|
|
7778
|
+
accountId: {
|
|
7779
|
+
type: 'string',
|
|
7780
|
+
description: 'Account ID'
|
|
7781
|
+
},
|
|
7782
|
+
accountPath: {
|
|
7783
|
+
type: 'string',
|
|
7784
|
+
description: 'Full account path',
|
|
7785
|
+
example: 'Assets:US:Fidelity:Brokerage'
|
|
7786
|
+
},
|
|
7787
|
+
accountCurrency: {
|
|
7788
|
+
type: 'string',
|
|
7789
|
+
description:
|
|
7790
|
+
'Currency of the holding with the largest converted base value; undefined when no holding is convertible',
|
|
7791
|
+
example: 'USD'
|
|
7792
|
+
},
|
|
7793
|
+
marketValueBase: {
|
|
7794
|
+
type: 'string',
|
|
7795
|
+
description:
|
|
7796
|
+
"Account's market value in base currency (Σ converted holdings; grey bucket included)",
|
|
7797
|
+
example: '50000.00'
|
|
6071
7798
|
},
|
|
6072
|
-
|
|
7799
|
+
shareOfTotalPct: {
|
|
6073
7800
|
type: 'number',
|
|
6074
|
-
description:
|
|
7801
|
+
description:
|
|
7802
|
+
'Share of the global total (0-100). 0 when globalTotal is zero (no NaN/Infinity).',
|
|
7803
|
+
example: 42.5
|
|
6075
7804
|
},
|
|
6076
|
-
|
|
6077
|
-
|
|
6078
|
-
|
|
6079
|
-
|
|
7805
|
+
groups: {
|
|
7806
|
+
description: 'Per-account asset-class breakdown',
|
|
7807
|
+
type: 'array',
|
|
7808
|
+
items: {
|
|
7809
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7810
|
+
}
|
|
6080
7811
|
},
|
|
6081
|
-
|
|
6082
|
-
description:
|
|
7812
|
+
uncategorized: {
|
|
7813
|
+
description:
|
|
7814
|
+
'Per-account grey bucket (source=FALLBACK holdings, incl. broker cash)',
|
|
7815
|
+
allOf: [
|
|
7816
|
+
{
|
|
7817
|
+
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
7818
|
+
}
|
|
7819
|
+
]
|
|
7820
|
+
},
|
|
7821
|
+
holdings: {
|
|
7822
|
+
description:
|
|
7823
|
+
'Every holding row for this account (account ID in each row’s `id` field)',
|
|
6083
7824
|
type: 'array',
|
|
6084
7825
|
items: {
|
|
6085
|
-
$ref: '#/components/schemas/
|
|
7826
|
+
$ref: '#/components/schemas/AccountItemWithAssetClassDto'
|
|
6086
7827
|
}
|
|
6087
7828
|
}
|
|
6088
7829
|
},
|
|
6089
|
-
required: [
|
|
7830
|
+
required: [
|
|
7831
|
+
'accountId',
|
|
7832
|
+
'accountPath',
|
|
7833
|
+
'marketValueBase',
|
|
7834
|
+
'shareOfTotalPct',
|
|
7835
|
+
'groups',
|
|
7836
|
+
'holdings'
|
|
7837
|
+
]
|
|
6090
7838
|
} as const;
|
|
6091
7839
|
|
|
6092
|
-
export const $
|
|
7840
|
+
export const $HoldingAssetClassCrossAccountResponseDto = {
|
|
6093
7841
|
type: 'object',
|
|
6094
7842
|
properties: {
|
|
6095
|
-
|
|
6096
|
-
description: '
|
|
6097
|
-
type: 'array',
|
|
6098
|
-
items: {
|
|
6099
|
-
$ref: '#/components/schemas/AssetClassGroupDto'
|
|
6100
|
-
}
|
|
6101
|
-
},
|
|
6102
|
-
summary: {
|
|
6103
|
-
description: 'Summary statistics',
|
|
7843
|
+
global: {
|
|
7844
|
+
description: 'Merged cross-account holding aggregation',
|
|
6104
7845
|
allOf: [
|
|
6105
7846
|
{
|
|
6106
|
-
$ref: '#/components/schemas/
|
|
7847
|
+
$ref: '#/components/schemas/AssetClassAccountsResponseDto'
|
|
6107
7848
|
}
|
|
6108
7849
|
]
|
|
7850
|
+
},
|
|
7851
|
+
byAccount: {
|
|
7852
|
+
description: 'Per-account slices',
|
|
7853
|
+
type: 'array',
|
|
7854
|
+
items: {
|
|
7855
|
+
$ref: '#/components/schemas/HoldingAssetClassAccountSliceDto'
|
|
7856
|
+
}
|
|
6109
7857
|
}
|
|
6110
7858
|
},
|
|
6111
|
-
required: ['
|
|
7859
|
+
required: ['global', 'byAccount']
|
|
6112
7860
|
} as const;
|
|
6113
7861
|
|
|
6114
7862
|
export const $CashFlowByCurrencyDto = {
|
|
@@ -6210,207 +7958,582 @@ export const $CashFlowResponseDto = {
|
|
|
6210
7958
|
description: 'Cash flow grouped by original currency',
|
|
6211
7959
|
allOf: [
|
|
6212
7960
|
{
|
|
6213
|
-
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
7961
|
+
$ref: '#/components/schemas/CashFlowByCurrencyDto'
|
|
7962
|
+
}
|
|
7963
|
+
]
|
|
7964
|
+
},
|
|
7965
|
+
converted: {
|
|
7966
|
+
description: 'Converted values in base currency',
|
|
7967
|
+
allOf: [
|
|
7968
|
+
{
|
|
7969
|
+
$ref: '#/components/schemas/ConvertedCashFlowDto'
|
|
7970
|
+
}
|
|
7971
|
+
]
|
|
7972
|
+
},
|
|
7973
|
+
warnings: {
|
|
7974
|
+
description: 'Exchange rate warnings',
|
|
7975
|
+
type: 'array',
|
|
7976
|
+
items: {
|
|
7977
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
7978
|
+
}
|
|
7979
|
+
}
|
|
7980
|
+
},
|
|
7981
|
+
required: [
|
|
7982
|
+
'period',
|
|
7983
|
+
'income',
|
|
7984
|
+
'expense',
|
|
7985
|
+
'netSavings',
|
|
7986
|
+
'savingsRate',
|
|
7987
|
+
'currency'
|
|
7988
|
+
]
|
|
7989
|
+
} as const;
|
|
7990
|
+
|
|
7991
|
+
export const $CategoryGroupDto = {
|
|
7992
|
+
type: 'object',
|
|
7993
|
+
properties: {
|
|
7994
|
+
category: {
|
|
7995
|
+
type: 'string',
|
|
7996
|
+
description:
|
|
7997
|
+
'Functional category (account-path Group segment); regional and universal account paths merge under it',
|
|
7998
|
+
example: 'Food'
|
|
7999
|
+
},
|
|
8000
|
+
totalExpense: {
|
|
8001
|
+
type: 'string',
|
|
8002
|
+
description:
|
|
8003
|
+
'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
|
|
8004
|
+
example: '1200.00'
|
|
8005
|
+
},
|
|
8006
|
+
sharePct: {
|
|
8007
|
+
type: 'number',
|
|
8008
|
+
description: 'Share of grand total (0-100); 0 when grand total is 0',
|
|
8009
|
+
example: 42.5
|
|
8010
|
+
},
|
|
8011
|
+
balanceByCurrency: {
|
|
8012
|
+
description: 'Raw (unconverted) expense per currency',
|
|
8013
|
+
type: 'array',
|
|
8014
|
+
items: {
|
|
8015
|
+
$ref: '#/components/schemas/BalanceByCurrencyDto'
|
|
8016
|
+
}
|
|
8017
|
+
},
|
|
8018
|
+
convertedBalance: {
|
|
8019
|
+
type: 'string',
|
|
8020
|
+
description:
|
|
8021
|
+
'Converted total in base currency (omitted when FX missing for all currencies in this category)',
|
|
8022
|
+
example: '1200.00'
|
|
8023
|
+
}
|
|
8024
|
+
},
|
|
8025
|
+
required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
|
|
8026
|
+
} as const;
|
|
8027
|
+
|
|
8028
|
+
export const $ExpensesByCategorySummaryDto = {
|
|
8029
|
+
type: 'object',
|
|
8030
|
+
properties: {
|
|
8031
|
+
totalExpense: {
|
|
8032
|
+
type: 'string',
|
|
8033
|
+
description:
|
|
8034
|
+
'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
|
|
8035
|
+
example: '5000.00'
|
|
8036
|
+
},
|
|
8037
|
+
categoryCount: {
|
|
8038
|
+
type: 'number',
|
|
8039
|
+
description: 'Number of categories',
|
|
8040
|
+
example: 8
|
|
8041
|
+
}
|
|
8042
|
+
},
|
|
8043
|
+
required: ['totalExpense', 'categoryCount']
|
|
8044
|
+
} as const;
|
|
8045
|
+
|
|
8046
|
+
export const $ExpensesByCategoryResponseDto = {
|
|
8047
|
+
type: 'object',
|
|
8048
|
+
properties: {
|
|
8049
|
+
period: {
|
|
8050
|
+
type: 'string',
|
|
8051
|
+
description: 'Period requested',
|
|
8052
|
+
example: '1m'
|
|
8053
|
+
},
|
|
8054
|
+
baseCurrency: {
|
|
8055
|
+
type: 'string',
|
|
8056
|
+
description: 'Base currency for converted values',
|
|
8057
|
+
example: 'CNY'
|
|
8058
|
+
},
|
|
8059
|
+
groups: {
|
|
8060
|
+
description:
|
|
8061
|
+
'Expense groups by functional category, sorted by converted total desc',
|
|
8062
|
+
type: 'array',
|
|
8063
|
+
items: {
|
|
8064
|
+
$ref: '#/components/schemas/CategoryGroupDto'
|
|
8065
|
+
}
|
|
8066
|
+
},
|
|
8067
|
+
summary: {
|
|
8068
|
+
description: 'Summary statistics',
|
|
8069
|
+
allOf: [
|
|
8070
|
+
{
|
|
8071
|
+
$ref: '#/components/schemas/ExpensesByCategorySummaryDto'
|
|
8072
|
+
}
|
|
8073
|
+
]
|
|
8074
|
+
},
|
|
8075
|
+
warnings: {
|
|
8076
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
8077
|
+
type: 'array',
|
|
8078
|
+
items: {
|
|
8079
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
8080
|
+
}
|
|
8081
|
+
}
|
|
8082
|
+
},
|
|
8083
|
+
required: ['period', 'baseCurrency', 'groups', 'summary']
|
|
8084
|
+
} as const;
|
|
8085
|
+
|
|
8086
|
+
export const $MonetaryDto = {
|
|
8087
|
+
type: 'object',
|
|
8088
|
+
properties: {
|
|
8089
|
+
amount: {
|
|
8090
|
+
type: 'string',
|
|
8091
|
+
description: 'Amount (Decimal string)',
|
|
8092
|
+
example: '3000'
|
|
8093
|
+
},
|
|
8094
|
+
currency: {
|
|
8095
|
+
type: 'string',
|
|
8096
|
+
description: 'ISO 4217 currency',
|
|
8097
|
+
example: 'USD'
|
|
8098
|
+
},
|
|
8099
|
+
baseCcyEquivalent: {
|
|
8100
|
+
type: 'object',
|
|
8101
|
+
description: 'Converted to user base currency (Decimal string)',
|
|
8102
|
+
example: '21600',
|
|
8103
|
+
nullable: true
|
|
8104
|
+
}
|
|
8105
|
+
},
|
|
8106
|
+
required: ['amount', 'currency']
|
|
8107
|
+
} as const;
|
|
8108
|
+
|
|
8109
|
+
export const $CurrentPriceDto = {
|
|
8110
|
+
type: 'object',
|
|
8111
|
+
properties: {
|
|
8112
|
+
amount: {
|
|
8113
|
+
type: 'string',
|
|
8114
|
+
description: 'Price amount (Decimal string)',
|
|
8115
|
+
example: '250'
|
|
8116
|
+
},
|
|
8117
|
+
currency: {
|
|
8118
|
+
type: 'string',
|
|
8119
|
+
description: 'Price currency (ISO 4217)',
|
|
8120
|
+
example: 'USD'
|
|
8121
|
+
},
|
|
8122
|
+
date: {
|
|
8123
|
+
type: 'string',
|
|
8124
|
+
description: 'Price date (ISO 8601)',
|
|
8125
|
+
example: '2024-06-01'
|
|
8126
|
+
},
|
|
8127
|
+
source: {
|
|
8128
|
+
type: 'string',
|
|
8129
|
+
description: 'Price source',
|
|
8130
|
+
example: 'USER_OVERRIDE',
|
|
8131
|
+
enum: ['USER_OVERRIDE', 'OPENBB_EQUITY', 'OPENBB_CURRENCY']
|
|
8132
|
+
}
|
|
8133
|
+
},
|
|
8134
|
+
required: ['amount', 'currency', 'date', 'source']
|
|
8135
|
+
} as const;
|
|
8136
|
+
|
|
8137
|
+
export const $FxRateDto = {
|
|
8138
|
+
type: 'object',
|
|
8139
|
+
properties: {
|
|
8140
|
+
from: {
|
|
8141
|
+
type: 'string',
|
|
8142
|
+
example: 'USD'
|
|
8143
|
+
},
|
|
8144
|
+
to: {
|
|
8145
|
+
type: 'string',
|
|
8146
|
+
example: 'CNY'
|
|
8147
|
+
},
|
|
8148
|
+
rate: {
|
|
8149
|
+
type: 'string',
|
|
8150
|
+
description: 'FX rate (Decimal string)',
|
|
8151
|
+
example: '7.2'
|
|
8152
|
+
},
|
|
8153
|
+
date: {
|
|
8154
|
+
type: 'string',
|
|
8155
|
+
description: 'Rate date (ISO 8601)',
|
|
8156
|
+
example: '2024-01-15'
|
|
8157
|
+
}
|
|
8158
|
+
},
|
|
8159
|
+
required: ['from', 'to', 'rate', 'date']
|
|
8160
|
+
} as const;
|
|
8161
|
+
|
|
8162
|
+
export const $HoldingPnlRowDto = {
|
|
8163
|
+
type: 'object',
|
|
8164
|
+
properties: {
|
|
8165
|
+
accountId: {
|
|
8166
|
+
type: 'string',
|
|
8167
|
+
description: 'Account UUID',
|
|
8168
|
+
example: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
|
|
8169
|
+
},
|
|
8170
|
+
accountPath: {
|
|
8171
|
+
type: 'string',
|
|
8172
|
+
description: 'Full account path',
|
|
8173
|
+
example: 'Assets:US:Broker:AAPL'
|
|
8174
|
+
},
|
|
8175
|
+
accountCcy: {
|
|
8176
|
+
type: 'object',
|
|
8177
|
+
description: 'Account settlement currency (ISO 4217), from cost currency',
|
|
8178
|
+
nullable: true,
|
|
8179
|
+
example: 'USD'
|
|
8180
|
+
},
|
|
8181
|
+
brokerType: {
|
|
8182
|
+
type: 'object',
|
|
8183
|
+
description: 'Broker type derived from Platform.type',
|
|
8184
|
+
nullable: true,
|
|
8185
|
+
example: 'broker'
|
|
8186
|
+
},
|
|
8187
|
+
symbol: {
|
|
8188
|
+
type: 'string',
|
|
8189
|
+
description: 'Commodity symbol',
|
|
8190
|
+
example: 'AAPL'
|
|
8191
|
+
},
|
|
8192
|
+
chartToken: {
|
|
8193
|
+
type: 'string',
|
|
8194
|
+
description: 'Chart segment token (libs/common resolver)',
|
|
8195
|
+
example: 'equity',
|
|
8196
|
+
enum: ['equity', 'fund', 'bond', 'cash', 'other']
|
|
8197
|
+
},
|
|
8198
|
+
assetClass: {
|
|
8199
|
+
type: 'string',
|
|
8200
|
+
example: 'EQUITY'
|
|
8201
|
+
},
|
|
8202
|
+
assetSubClass: {
|
|
8203
|
+
type: 'object',
|
|
8204
|
+
nullable: true,
|
|
8205
|
+
example: 'STOCK'
|
|
8206
|
+
},
|
|
8207
|
+
units: {
|
|
8208
|
+
type: 'string',
|
|
8209
|
+
description: 'Net held units (Decimal string)',
|
|
8210
|
+
example: '12'
|
|
8211
|
+
},
|
|
8212
|
+
averageCostPerUnit: {
|
|
8213
|
+
description:
|
|
8214
|
+
'Average cost per unit; null when cost currency conflicts or no cost',
|
|
8215
|
+
nullable: true,
|
|
8216
|
+
allOf: [
|
|
8217
|
+
{
|
|
8218
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8219
|
+
}
|
|
8220
|
+
]
|
|
8221
|
+
},
|
|
8222
|
+
costBasis: {
|
|
8223
|
+
description: 'Cost basis of held units',
|
|
8224
|
+
nullable: true,
|
|
8225
|
+
allOf: [
|
|
8226
|
+
{
|
|
8227
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8228
|
+
}
|
|
8229
|
+
]
|
|
8230
|
+
},
|
|
8231
|
+
marketValue: {
|
|
8232
|
+
description: 'Market value at asOf price',
|
|
8233
|
+
nullable: true,
|
|
8234
|
+
allOf: [
|
|
8235
|
+
{
|
|
8236
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8237
|
+
}
|
|
8238
|
+
]
|
|
8239
|
+
},
|
|
8240
|
+
currentPrice: {
|
|
8241
|
+
description: 'Price used for market value',
|
|
8242
|
+
nullable: true,
|
|
8243
|
+
allOf: [
|
|
8244
|
+
{
|
|
8245
|
+
$ref: '#/components/schemas/CurrentPriceDto'
|
|
8246
|
+
}
|
|
8247
|
+
]
|
|
8248
|
+
},
|
|
8249
|
+
unrealizedPnlBase: {
|
|
8250
|
+
type: 'object',
|
|
8251
|
+
description:
|
|
8252
|
+
'Unrealized P&L in base currency (Decimal string); null when any FX/price missing',
|
|
8253
|
+
nullable: true,
|
|
8254
|
+
example: '6000'
|
|
8255
|
+
},
|
|
8256
|
+
unrealizedPnlPct: {
|
|
8257
|
+
type: 'object',
|
|
8258
|
+
description: 'Unrealized P&L % (Decimal string)',
|
|
8259
|
+
nullable: true,
|
|
8260
|
+
example: '25'
|
|
8261
|
+
},
|
|
8262
|
+
costFxRate: {
|
|
8263
|
+
description: 'Historical FX rate applied to cost basis',
|
|
8264
|
+
nullable: true,
|
|
8265
|
+
allOf: [
|
|
8266
|
+
{
|
|
8267
|
+
$ref: '#/components/schemas/FxRateDto'
|
|
6214
8268
|
}
|
|
6215
8269
|
]
|
|
6216
8270
|
},
|
|
6217
|
-
|
|
6218
|
-
description: '
|
|
8271
|
+
marketFxRate: {
|
|
8272
|
+
description: 'FX rate applied to market value',
|
|
8273
|
+
nullable: true,
|
|
6219
8274
|
allOf: [
|
|
6220
8275
|
{
|
|
6221
|
-
$ref: '#/components/schemas/
|
|
8276
|
+
$ref: '#/components/schemas/FxRateDto'
|
|
6222
8277
|
}
|
|
6223
8278
|
]
|
|
6224
8279
|
},
|
|
6225
|
-
|
|
6226
|
-
|
|
6227
|
-
|
|
6228
|
-
|
|
6229
|
-
|
|
6230
|
-
|
|
8280
|
+
pctOfInvestedAssets: {
|
|
8281
|
+
type: 'object',
|
|
8282
|
+
description:
|
|
8283
|
+
'Share of invested assets % (Decimal string); only for invested chartTokens',
|
|
8284
|
+
nullable: true,
|
|
8285
|
+
example: '40'
|
|
8286
|
+
},
|
|
8287
|
+
realizedPnl: {
|
|
8288
|
+
description:
|
|
8289
|
+
'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',
|
|
8290
|
+
nullable: true,
|
|
8291
|
+
allOf: [
|
|
8292
|
+
{
|
|
8293
|
+
$ref: '#/components/schemas/MonetaryDto'
|
|
8294
|
+
}
|
|
8295
|
+
]
|
|
6231
8296
|
}
|
|
6232
8297
|
},
|
|
6233
8298
|
required: [
|
|
6234
|
-
'
|
|
6235
|
-
'
|
|
6236
|
-
'
|
|
6237
|
-
'
|
|
6238
|
-
'
|
|
6239
|
-
'
|
|
8299
|
+
'accountId',
|
|
8300
|
+
'accountPath',
|
|
8301
|
+
'symbol',
|
|
8302
|
+
'chartToken',
|
|
8303
|
+
'assetClass',
|
|
8304
|
+
'units'
|
|
6240
8305
|
]
|
|
6241
8306
|
} as const;
|
|
6242
8307
|
|
|
6243
|
-
export const $
|
|
8308
|
+
export const $HoldingPnlWarningDto = {
|
|
6244
8309
|
type: 'object',
|
|
6245
8310
|
properties: {
|
|
6246
|
-
|
|
8311
|
+
type: {
|
|
6247
8312
|
type: 'string',
|
|
6248
|
-
description: '
|
|
6249
|
-
example: '
|
|
8313
|
+
description: 'Warning type',
|
|
8314
|
+
example: 'MISSING_COST_FX_RATE',
|
|
8315
|
+
enum: [
|
|
8316
|
+
'MISSING_COST_FX_RATE',
|
|
8317
|
+
'MISSING_MARKET_FX_RATE',
|
|
8318
|
+
'MISSING_SALE_PRICE',
|
|
8319
|
+
'MISSING_REALIZED_FX_RATE',
|
|
8320
|
+
'OVERSOLD_LOTS',
|
|
8321
|
+
'NO_PRICE',
|
|
8322
|
+
'MIXED_COST_CURRENCY'
|
|
8323
|
+
]
|
|
6250
8324
|
},
|
|
6251
|
-
|
|
6252
|
-
type: '
|
|
6253
|
-
|
|
6254
|
-
|
|
8325
|
+
symbol: {
|
|
8326
|
+
type: 'object',
|
|
8327
|
+
nullable: true
|
|
8328
|
+
},
|
|
8329
|
+
accountId: {
|
|
8330
|
+
type: 'object',
|
|
8331
|
+
nullable: true
|
|
8332
|
+
},
|
|
8333
|
+
currency: {
|
|
8334
|
+
type: 'object',
|
|
8335
|
+
nullable: true
|
|
6255
8336
|
}
|
|
6256
8337
|
},
|
|
6257
|
-
required: ['
|
|
8338
|
+
required: ['type']
|
|
6258
8339
|
} as const;
|
|
6259
8340
|
|
|
6260
|
-
export const $
|
|
8341
|
+
export const $HoldingPnlResponseDto = {
|
|
6261
8342
|
type: 'object',
|
|
6262
8343
|
properties: {
|
|
6263
|
-
|
|
8344
|
+
asOfDate: {
|
|
6264
8345
|
type: 'string',
|
|
6265
|
-
|
|
6266
|
-
example: '2024-06-15'
|
|
8346
|
+
example: '2026-07-08'
|
|
6267
8347
|
},
|
|
6268
|
-
|
|
8348
|
+
baseCurrency: {
|
|
6269
8349
|
type: 'string',
|
|
6270
|
-
|
|
6271
|
-
example: '500000.00'
|
|
8350
|
+
example: 'CNY'
|
|
6272
8351
|
},
|
|
6273
|
-
|
|
6274
|
-
type: '
|
|
6275
|
-
description:
|
|
6276
|
-
|
|
8352
|
+
method: {
|
|
8353
|
+
type: 'string',
|
|
8354
|
+
description:
|
|
8355
|
+
'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
|
|
8356
|
+
enum: ['average', 'FIFO'],
|
|
8357
|
+
example: 'average'
|
|
6277
8358
|
},
|
|
6278
|
-
|
|
6279
|
-
description: 'Multi-currency breakdown for this point',
|
|
8359
|
+
rows: {
|
|
6280
8360
|
type: 'array',
|
|
6281
8361
|
items: {
|
|
6282
|
-
$ref: '#/components/schemas/
|
|
8362
|
+
$ref: '#/components/schemas/HoldingPnlRowDto'
|
|
8363
|
+
}
|
|
8364
|
+
},
|
|
8365
|
+
warnings: {
|
|
8366
|
+
type: 'array',
|
|
8367
|
+
items: {
|
|
8368
|
+
$ref: '#/components/schemas/HoldingPnlWarningDto'
|
|
6283
8369
|
}
|
|
6284
8370
|
}
|
|
6285
8371
|
},
|
|
6286
|
-
required: ['
|
|
8372
|
+
required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
|
|
6287
8373
|
} as const;
|
|
6288
8374
|
|
|
6289
|
-
export const $
|
|
8375
|
+
export const $AnonymousLoginDto = {
|
|
6290
8376
|
type: 'object',
|
|
6291
8377
|
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: {
|
|
8378
|
+
accessToken: {
|
|
6308
8379
|
type: 'string',
|
|
6309
|
-
description: '
|
|
6310
|
-
example: '+11.11%'
|
|
8380
|
+
description: 'Access token for anonymous login'
|
|
6311
8381
|
}
|
|
6312
8382
|
},
|
|
6313
|
-
required: ['
|
|
8383
|
+
required: ['accessToken']
|
|
6314
8384
|
} as const;
|
|
6315
8385
|
|
|
6316
|
-
export const $
|
|
8386
|
+
export const $AnonymousLoginResponseDto = {
|
|
6317
8387
|
type: 'object',
|
|
6318
8388
|
properties: {
|
|
6319
|
-
|
|
8389
|
+
authToken: {
|
|
6320
8390
|
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
|
-
}
|
|
8391
|
+
description: 'JWT auth token',
|
|
8392
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
6330
8393
|
}
|
|
6331
8394
|
},
|
|
6332
|
-
required: ['
|
|
8395
|
+
required: ['authToken']
|
|
6333
8396
|
} as const;
|
|
6334
8397
|
|
|
6335
|
-
export const $
|
|
8398
|
+
export const $SymbolSearchResultDto = {
|
|
6336
8399
|
type: 'object',
|
|
6337
8400
|
properties: {
|
|
6338
|
-
|
|
6339
|
-
|
|
6340
|
-
|
|
6341
|
-
items: {
|
|
6342
|
-
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
6343
|
-
}
|
|
8401
|
+
symbol: {
|
|
8402
|
+
type: 'string',
|
|
8403
|
+
example: 'AAPL'
|
|
6344
8404
|
},
|
|
6345
|
-
|
|
6346
|
-
|
|
6347
|
-
|
|
6348
|
-
|
|
6349
|
-
$ref: '#/components/schemas/TrendSummaryDto'
|
|
6350
|
-
}
|
|
6351
|
-
]
|
|
8405
|
+
name: {
|
|
8406
|
+
type: 'object',
|
|
8407
|
+
example: 'Apple Inc.',
|
|
8408
|
+
nullable: true
|
|
6352
8409
|
},
|
|
6353
|
-
|
|
6354
|
-
type: '
|
|
6355
|
-
|
|
6356
|
-
|
|
8410
|
+
exchange: {
|
|
8411
|
+
type: 'object',
|
|
8412
|
+
example: 'US',
|
|
8413
|
+
nullable: true
|
|
6357
8414
|
},
|
|
6358
|
-
|
|
6359
|
-
type: '
|
|
6360
|
-
description: '
|
|
6361
|
-
example: '
|
|
8415
|
+
assetType: {
|
|
8416
|
+
type: 'object',
|
|
8417
|
+
description: 'OpenBB asset_type (e.g. stock, etf)',
|
|
8418
|
+
example: 'stock',
|
|
8419
|
+
nullable: true
|
|
6362
8420
|
},
|
|
6363
|
-
|
|
6364
|
-
type: '
|
|
6365
|
-
description: '
|
|
6366
|
-
example: '
|
|
8421
|
+
assetClass: {
|
|
8422
|
+
type: 'object',
|
|
8423
|
+
description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
|
|
8424
|
+
example: 'EQUITY',
|
|
8425
|
+
nullable: true
|
|
6367
8426
|
},
|
|
6368
|
-
|
|
6369
|
-
|
|
6370
|
-
|
|
6371
|
-
|
|
6372
|
-
|
|
6373
|
-
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
6374
|
-
}
|
|
8427
|
+
assetSubClass: {
|
|
8428
|
+
type: 'object',
|
|
8429
|
+
description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
|
|
8430
|
+
example: 'STOCK',
|
|
8431
|
+
nullable: true
|
|
6375
8432
|
},
|
|
6376
|
-
|
|
6377
|
-
|
|
6378
|
-
|
|
6379
|
-
|
|
6380
|
-
|
|
6381
|
-
}
|
|
8433
|
+
currency: {
|
|
8434
|
+
type: 'object',
|
|
8435
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8436
|
+
example: 'USD',
|
|
8437
|
+
nullable: true
|
|
6382
8438
|
}
|
|
6383
8439
|
},
|
|
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: {}
|
|
8440
|
+
required: ['symbol']
|
|
6405
8441
|
} as const;
|
|
6406
8442
|
|
|
6407
|
-
export const $
|
|
8443
|
+
export const $SymbolQuoteDto = {
|
|
6408
8444
|
type: 'object',
|
|
6409
8445
|
properties: {
|
|
6410
|
-
|
|
8446
|
+
symbol: {
|
|
6411
8447
|
type: 'string',
|
|
6412
|
-
|
|
8448
|
+
example: 'AAPL'
|
|
8449
|
+
},
|
|
8450
|
+
name: {
|
|
8451
|
+
type: 'object',
|
|
8452
|
+
example: 'Apple Inc.',
|
|
8453
|
+
nullable: true
|
|
8454
|
+
},
|
|
8455
|
+
exchange: {
|
|
8456
|
+
type: 'object',
|
|
8457
|
+
example: 'US',
|
|
8458
|
+
nullable: true
|
|
8459
|
+
},
|
|
8460
|
+
assetType: {
|
|
8461
|
+
type: 'object',
|
|
8462
|
+
description: 'OpenBB asset_type',
|
|
8463
|
+
example: 'stock',
|
|
8464
|
+
nullable: true
|
|
8465
|
+
},
|
|
8466
|
+
assetClass: {
|
|
8467
|
+
type: 'object',
|
|
8468
|
+
description: 'IGN asset class',
|
|
8469
|
+
example: 'EQUITY',
|
|
8470
|
+
nullable: true
|
|
8471
|
+
},
|
|
8472
|
+
assetSubClass: {
|
|
8473
|
+
type: 'object',
|
|
8474
|
+
description: 'IGN asset sub-class',
|
|
8475
|
+
example: 'STOCK',
|
|
8476
|
+
nullable: true
|
|
8477
|
+
},
|
|
8478
|
+
currency: {
|
|
8479
|
+
type: 'object',
|
|
8480
|
+
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8481
|
+
example: 'USD',
|
|
8482
|
+
nullable: true
|
|
8483
|
+
},
|
|
8484
|
+
price: {
|
|
8485
|
+
type: 'object',
|
|
8486
|
+
description: 'Latest price (Decimal string)',
|
|
8487
|
+
example: '189.84',
|
|
8488
|
+
nullable: true
|
|
8489
|
+
},
|
|
8490
|
+
priceDate: {
|
|
8491
|
+
type: 'object',
|
|
8492
|
+
description: 'Date the price was observed (ISO yyyy-MM-dd)',
|
|
8493
|
+
example: '2026-08-05',
|
|
8494
|
+
nullable: true
|
|
8495
|
+
},
|
|
8496
|
+
changePercent: {
|
|
8497
|
+
type: 'object',
|
|
8498
|
+
description:
|
|
8499
|
+
'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.',
|
|
8500
|
+
example: 1.7,
|
|
8501
|
+
nullable: true
|
|
8502
|
+
},
|
|
8503
|
+
prevClose: {
|
|
8504
|
+
type: 'object',
|
|
8505
|
+
description: 'Previous close (Decimal string)',
|
|
8506
|
+
nullable: true
|
|
8507
|
+
},
|
|
8508
|
+
open: {
|
|
8509
|
+
type: 'object',
|
|
8510
|
+
description: 'Day open (Decimal string)',
|
|
8511
|
+
nullable: true
|
|
8512
|
+
},
|
|
8513
|
+
high: {
|
|
8514
|
+
type: 'object',
|
|
8515
|
+
description: 'Day high (Decimal string)',
|
|
8516
|
+
nullable: true
|
|
8517
|
+
},
|
|
8518
|
+
low: {
|
|
8519
|
+
type: 'object',
|
|
8520
|
+
description: 'Day low (Decimal string)',
|
|
8521
|
+
nullable: true
|
|
8522
|
+
},
|
|
8523
|
+
volume: {
|
|
8524
|
+
type: 'object',
|
|
8525
|
+
description: 'Day volume (Decimal string)',
|
|
8526
|
+
nullable: true
|
|
8527
|
+
},
|
|
8528
|
+
yearHigh: {
|
|
8529
|
+
type: 'object',
|
|
8530
|
+
description: '52-week high (Decimal string)',
|
|
8531
|
+
nullable: true
|
|
8532
|
+
},
|
|
8533
|
+
yearLow: {
|
|
8534
|
+
type: 'object',
|
|
8535
|
+
description: '52-week low (Decimal string)',
|
|
8536
|
+
nullable: true
|
|
6413
8537
|
}
|
|
6414
|
-
}
|
|
6415
|
-
required: ['accessToken']
|
|
8538
|
+
}
|
|
6416
8539
|
} as const;
|