@firela/api-types 0.0.0-canary.da8dfd93 → 0.0.0-canary.de851cbd
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 +1458 -1210
- package/dist/index.d.ts +1458 -1210
- package/dist/index.js +6 -4
- package/dist/index.mjs +6 -4
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +1625 -1048
- package/src/generated/services.gen.ts +613 -545
- package/src/generated/types.gen.ts +19517 -1406
|
@@ -51,6 +51,14 @@ export const $CreateAccountDto = {
|
|
|
51
51
|
description: 'Icon identifier (overrides template)',
|
|
52
52
|
example: 'bank-custom'
|
|
53
53
|
},
|
|
54
|
+
displayName: {
|
|
55
|
+
type: 'string',
|
|
56
|
+
description:
|
|
57
|
+
'User-set display name override (omit/null = keep the derived name)',
|
|
58
|
+
nullable: true,
|
|
59
|
+
maxLength: 50,
|
|
60
|
+
example: 'Salary card'
|
|
61
|
+
},
|
|
54
62
|
openDirectiveMeta: {
|
|
55
63
|
type: 'object',
|
|
56
64
|
description:
|
|
@@ -181,7 +189,8 @@ export const $AccountResponseDto = {
|
|
|
181
189
|
},
|
|
182
190
|
displayName: {
|
|
183
191
|
type: 'string',
|
|
184
|
-
description:
|
|
192
|
+
description:
|
|
193
|
+
'Display name with precedence: user-set name (#762) > ADR-0114 localized name > path leaf (read-time projection)',
|
|
185
194
|
example: 'Checking'
|
|
186
195
|
},
|
|
187
196
|
icon: {
|
|
@@ -197,7 +206,7 @@ export const $AccountResponseDto = {
|
|
|
197
206
|
}
|
|
198
207
|
},
|
|
199
208
|
platformId: {
|
|
200
|
-
type: '
|
|
209
|
+
type: 'string',
|
|
201
210
|
description: 'Platform ID (null if unbound)',
|
|
202
211
|
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
203
212
|
},
|
|
@@ -277,6 +286,14 @@ export const $UpdateAccountDto = {
|
|
|
277
286
|
description: 'Icon identifier',
|
|
278
287
|
example: 'bank-custom'
|
|
279
288
|
},
|
|
289
|
+
displayName: {
|
|
290
|
+
type: 'string',
|
|
291
|
+
description:
|
|
292
|
+
'User-set display name override (null = clear the override and fall back to the derived name, omit = unchanged)',
|
|
293
|
+
nullable: true,
|
|
294
|
+
maxLength: 50,
|
|
295
|
+
example: 'Salary card'
|
|
296
|
+
},
|
|
280
297
|
openDirectiveMeta: {
|
|
281
298
|
type: 'object',
|
|
282
299
|
description:
|
|
@@ -377,16 +394,43 @@ export const $AccountStandardResponseDto = {
|
|
|
377
394
|
},
|
|
378
395
|
name: {
|
|
379
396
|
type: 'string',
|
|
380
|
-
description:
|
|
397
|
+
description:
|
|
398
|
+
'Short display name. Universal rows project to the request locale (Accept-Language); regional rows keep the authored native name — mixed-language by design (ADR-0131 class P vs class A).',
|
|
381
399
|
example: 'Housing Fund'
|
|
382
400
|
},
|
|
401
|
+
aliases: {
|
|
402
|
+
description:
|
|
403
|
+
'Authored market-language alternative names delivered verbatim (not localized copy, not xlf-managed, not locale-projected). Flat string[] per ADR-0129 D1; ADR-0131 class A.',
|
|
404
|
+
example: ['Alipay', 'WeChat Pay'],
|
|
405
|
+
type: 'array',
|
|
406
|
+
items: {
|
|
407
|
+
type: 'string'
|
|
408
|
+
}
|
|
409
|
+
},
|
|
410
|
+
searchTerms: {
|
|
411
|
+
description:
|
|
412
|
+
'Locale-projected search synonyms (e.g. the zh bank-card / debit-card everyday terms for the checking account). Pure-locale projection — absent when the locale has no seeded synonyms; English fallback rides the authored aliases field. Search-only vocabulary, not the NLP routing corpus (#698, ADR-0131 fourth-class adjudication).',
|
|
413
|
+
example: ['yinhangka', 'jiejika'],
|
|
414
|
+
type: 'array',
|
|
415
|
+
items: {
|
|
416
|
+
type: 'string'
|
|
417
|
+
}
|
|
418
|
+
},
|
|
419
|
+
currency: {
|
|
420
|
+
type: 'string',
|
|
421
|
+
description:
|
|
422
|
+
'Product denomination as a 3-letter ISO 4217 code, authored market data delivered verbatim (not localized, not xlf-managed). ADR-0131 class A. Absent = single-currency not asserted — consumers fall back to their own region currency (#714).',
|
|
423
|
+
example: 'HKD'
|
|
424
|
+
},
|
|
383
425
|
description: {
|
|
384
426
|
type: 'string',
|
|
385
|
-
description:
|
|
427
|
+
description:
|
|
428
|
+
'Account description (stable semantics only). Mixed-language contract: universal rows project to the request locale via the accountDesc xlf axis with an en fallback (ADR-0131 class P, ADR-0132; unseeded locales falling back to English are expected); regional rows deliver the authored market language (ADR-0131 class A, verbatim, never xlf-managed).',
|
|
386
429
|
example: 'ICBC checking account for daily transactions'
|
|
387
430
|
},
|
|
388
431
|
tags: {
|
|
389
|
-
description:
|
|
432
|
+
description:
|
|
433
|
+
'Account tags for categorization — structured metadata delivered verbatim (not localized, not xlf-managed). ADR-0131 class A.',
|
|
390
434
|
example: ['bank', 'checking', 'primary'],
|
|
391
435
|
type: 'array',
|
|
392
436
|
items: {
|
|
@@ -498,7 +542,10 @@ export const $RegionConfigDto = {
|
|
|
498
542
|
},
|
|
499
543
|
locale: {
|
|
500
544
|
type: 'string',
|
|
501
|
-
example: 'de-DE'
|
|
545
|
+
example: 'de-DE',
|
|
546
|
+
pattern: '^[a-z]{2,8}-[A-Z]{2}$',
|
|
547
|
+
description:
|
|
548
|
+
"Region-qualified BCP-47 tag whose region subtag equals the region's own ISO 3166-1 code (e.g., ja-JP, zh-CN, zh-HK)"
|
|
502
549
|
}
|
|
503
550
|
},
|
|
504
551
|
required: ['currency', 'dateFormat', 'locale']
|
|
@@ -511,6 +558,12 @@ export const $RegionInfoDto = {
|
|
|
511
558
|
type: 'string',
|
|
512
559
|
example: 'de'
|
|
513
560
|
},
|
|
561
|
+
open: {
|
|
562
|
+
type: 'boolean',
|
|
563
|
+
example: true,
|
|
564
|
+
description:
|
|
565
|
+
'Whether the region is open (has a ready regional account template). Not-yet-open regions still return identity metadata and degrade to the universal-only catalog.'
|
|
566
|
+
},
|
|
514
567
|
displayName: {
|
|
515
568
|
type: 'string',
|
|
516
569
|
example: 'Germany'
|
|
@@ -529,7 +582,7 @@ export const $RegionInfoDto = {
|
|
|
529
582
|
$ref: '#/components/schemas/RegionConfigDto'
|
|
530
583
|
}
|
|
531
584
|
},
|
|
532
|
-
required: ['code', 'displayName', 'chain', 'config']
|
|
585
|
+
required: ['code', 'open', 'displayName', 'chain', 'config']
|
|
533
586
|
} as const;
|
|
534
587
|
|
|
535
588
|
export const $RegionsMetadataResponseDto = {
|
|
@@ -776,7 +829,7 @@ export const $PostingResponseDto = {
|
|
|
776
829
|
units: {
|
|
777
830
|
type: 'string',
|
|
778
831
|
description:
|
|
779
|
-
'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
|
|
832
|
+
'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned. Carries the raw Beancount sign (credit-normal accounts such as Income post negative — the accounting truth, ADR-0126); renderers must not infer economic semantics from this sign.',
|
|
780
833
|
example: '100.50'
|
|
781
834
|
},
|
|
782
835
|
currency: {
|
|
@@ -1142,7 +1195,7 @@ export const $PostingDetailDto = {
|
|
|
1142
1195
|
units: {
|
|
1143
1196
|
type: 'string',
|
|
1144
1197
|
description:
|
|
1145
|
-
'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
|
|
1198
|
+
'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned. Carries the raw Beancount sign (credit-normal accounts such as Income post negative — the accounting truth, ADR-0126); renderers must not infer economic semantics from this sign.',
|
|
1146
1199
|
example: '100.50'
|
|
1147
1200
|
},
|
|
1148
1201
|
currency: {
|
|
@@ -1326,6 +1379,147 @@ export const $TransactionDetailDto = {
|
|
|
1326
1379
|
]
|
|
1327
1380
|
} as const;
|
|
1328
1381
|
|
|
1382
|
+
export const $TransactionListItemDto = {
|
|
1383
|
+
type: 'object',
|
|
1384
|
+
properties: {
|
|
1385
|
+
id: {
|
|
1386
|
+
type: 'string',
|
|
1387
|
+
description: 'Transaction ID',
|
|
1388
|
+
example: 'clh1234567890abcdef'
|
|
1389
|
+
},
|
|
1390
|
+
date: {
|
|
1391
|
+
type: 'string',
|
|
1392
|
+
description: 'Transaction date',
|
|
1393
|
+
example: '2024-11-28'
|
|
1394
|
+
},
|
|
1395
|
+
flag: {
|
|
1396
|
+
type: 'string',
|
|
1397
|
+
description: 'Transaction flag',
|
|
1398
|
+
enum: [
|
|
1399
|
+
'CLEARED',
|
|
1400
|
+
'PENDING',
|
|
1401
|
+
'PADDING',
|
|
1402
|
+
'SUMMARIZE',
|
|
1403
|
+
'TRANSFER',
|
|
1404
|
+
'CONVERSIONS'
|
|
1405
|
+
],
|
|
1406
|
+
example: 'CLEARED'
|
|
1407
|
+
},
|
|
1408
|
+
customFlag: {
|
|
1409
|
+
type: 'string',
|
|
1410
|
+
description: 'Custom flag (if not using standard flags)',
|
|
1411
|
+
example: 'R'
|
|
1412
|
+
},
|
|
1413
|
+
payee: {
|
|
1414
|
+
type: 'string',
|
|
1415
|
+
description: 'Payee name',
|
|
1416
|
+
example: 'Whole Foods Market'
|
|
1417
|
+
},
|
|
1418
|
+
narration: {
|
|
1419
|
+
type: 'string',
|
|
1420
|
+
description: 'Transaction narration',
|
|
1421
|
+
example: 'Grocery shopping'
|
|
1422
|
+
},
|
|
1423
|
+
tags: {
|
|
1424
|
+
description: 'Transaction tags',
|
|
1425
|
+
example: ['groceries'],
|
|
1426
|
+
type: 'array',
|
|
1427
|
+
items: {
|
|
1428
|
+
type: 'string'
|
|
1429
|
+
}
|
|
1430
|
+
},
|
|
1431
|
+
links: {
|
|
1432
|
+
description: 'Transaction links',
|
|
1433
|
+
example: ['invoice-2024-001'],
|
|
1434
|
+
type: 'array',
|
|
1435
|
+
items: {
|
|
1436
|
+
type: 'string'
|
|
1437
|
+
}
|
|
1438
|
+
},
|
|
1439
|
+
meta: {
|
|
1440
|
+
type: 'object',
|
|
1441
|
+
description: 'Transaction metadata'
|
|
1442
|
+
},
|
|
1443
|
+
status: {
|
|
1444
|
+
type: 'string',
|
|
1445
|
+
description: 'Transaction status',
|
|
1446
|
+
enum: ['ACTIVE', 'VOIDED', 'SUPERSEDED'],
|
|
1447
|
+
example: 'ACTIVE'
|
|
1448
|
+
},
|
|
1449
|
+
sourceType: {
|
|
1450
|
+
type: 'string',
|
|
1451
|
+
description:
|
|
1452
|
+
'Source type (free-form string from transaction metadata, e.g. import, api)'
|
|
1453
|
+
},
|
|
1454
|
+
sourcePlatform: {
|
|
1455
|
+
type: 'string',
|
|
1456
|
+
description: 'Source platform (e.g., alipay, wechat)',
|
|
1457
|
+
example: 'alipay'
|
|
1458
|
+
},
|
|
1459
|
+
postings: {
|
|
1460
|
+
description: 'Transaction postings',
|
|
1461
|
+
type: 'array',
|
|
1462
|
+
items: {
|
|
1463
|
+
$ref: '#/components/schemas/PostingDetailDto'
|
|
1464
|
+
}
|
|
1465
|
+
},
|
|
1466
|
+
createdAt: {
|
|
1467
|
+
type: 'string',
|
|
1468
|
+
description: 'Created at timestamp',
|
|
1469
|
+
example: '2024-11-28T10:30:00.000Z'
|
|
1470
|
+
},
|
|
1471
|
+
voidedAt: {
|
|
1472
|
+
type: 'string',
|
|
1473
|
+
description: 'Voided at timestamp (if voided)',
|
|
1474
|
+
example: '2024-11-29T15:00:00.000Z'
|
|
1475
|
+
},
|
|
1476
|
+
voidedBy: {
|
|
1477
|
+
type: 'string',
|
|
1478
|
+
description: 'User ID who voided this transaction',
|
|
1479
|
+
example: 'clh1234567890abcdef'
|
|
1480
|
+
},
|
|
1481
|
+
correctionReason: {
|
|
1482
|
+
type: 'string',
|
|
1483
|
+
description: 'Correction reason (if voided or superseded)',
|
|
1484
|
+
example: 'Duplicate entry'
|
|
1485
|
+
},
|
|
1486
|
+
supersededBy: {
|
|
1487
|
+
type: 'string',
|
|
1488
|
+
description:
|
|
1489
|
+
'ID of the transaction that supersedes this one (set when status=SUPERSEDED)',
|
|
1490
|
+
example: 'clh1234567890abcdef'
|
|
1491
|
+
},
|
|
1492
|
+
originalTxn: {
|
|
1493
|
+
type: 'string',
|
|
1494
|
+
description:
|
|
1495
|
+
'ID of the transaction this one corrected/replaced (back-link on the replacement)',
|
|
1496
|
+
example: 'clh1234567890abcdef'
|
|
1497
|
+
},
|
|
1498
|
+
viewpointAmount: {
|
|
1499
|
+
type: 'string',
|
|
1500
|
+
description:
|
|
1501
|
+
'Row amount under the request viewpoint (ADR-0126). Category viewpoint (category + flow): per-leg sign-normalized sum over the category account set (Income-root legs negated, Expenses-root identity) — positive under normal booking but NOT clamped (explicit negative expense legs and net-flip refund months stay negative). No viewpoint (plain list / search, no accountId): wallet money-flow net = raw-sign sum over cost-less Assets/Liabilities legs (income positive, expenses negative, transfers net ~0); color cue is the wallet sign (net < 0 = wealth-decreasing). Status-orthogonal: audit views match too (ADR-0128 amount-as-matching-key). Omitted under the account viewpoint (incl. dual) and for rows with no wallet leg.',
|
|
1502
|
+
example: '10000.00'
|
|
1503
|
+
},
|
|
1504
|
+
viewpointCurrency: {
|
|
1505
|
+
type: 'string',
|
|
1506
|
+
description:
|
|
1507
|
+
'Currency of viewpointAmount. A row spanning multiple currencies takes the largest-magnitude currency group (known simplification, ADR-0126).',
|
|
1508
|
+
example: 'CNY'
|
|
1509
|
+
}
|
|
1510
|
+
},
|
|
1511
|
+
required: [
|
|
1512
|
+
'id',
|
|
1513
|
+
'date',
|
|
1514
|
+
'narration',
|
|
1515
|
+
'tags',
|
|
1516
|
+
'links',
|
|
1517
|
+
'status',
|
|
1518
|
+
'postings',
|
|
1519
|
+
'createdAt'
|
|
1520
|
+
]
|
|
1521
|
+
} as const;
|
|
1522
|
+
|
|
1329
1523
|
export const $BalanceByCurrencyDto = {
|
|
1330
1524
|
type: 'object',
|
|
1331
1525
|
properties: {
|
|
@@ -1371,7 +1565,7 @@ export const $TransactionListSummaryDto = {
|
|
|
1371
1565
|
totalAmount: {
|
|
1372
1566
|
type: 'string',
|
|
1373
1567
|
description:
|
|
1374
|
-
'Partial converted total in base currency (rated currencies only
|
|
1568
|
+
'Partial converted total in base currency (rated currencies only). Sign by viewpoint (ADR-0126): account viewpoint keeps the raw Beancount sign (income negative); category viewpoint is per-leg sign-normalized (Income legs negated, Expenses legs identity — positive under normal booking, not clamped). 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
1569
|
example: '-6000.00'
|
|
1376
1570
|
},
|
|
1377
1571
|
currency: {
|
|
@@ -1397,6 +1591,26 @@ export const $TransactionListSummaryDto = {
|
|
|
1397
1591
|
required: ['totalAmount', 'currency', 'balanceByCurrency']
|
|
1398
1592
|
} as const;
|
|
1399
1593
|
|
|
1594
|
+
export const $TransactionListViewpointDto = {
|
|
1595
|
+
type: 'object',
|
|
1596
|
+
properties: {
|
|
1597
|
+
type: {
|
|
1598
|
+
type: 'string',
|
|
1599
|
+
description:
|
|
1600
|
+
'Viewpoint type (only category drill-down carries a viewpoint today)',
|
|
1601
|
+
enum: ['category'],
|
|
1602
|
+
example: 'category'
|
|
1603
|
+
},
|
|
1604
|
+
flow: {
|
|
1605
|
+
type: 'string',
|
|
1606
|
+
description: 'Flow root the category account set is restricted to',
|
|
1607
|
+
enum: ['income', 'expense'],
|
|
1608
|
+
example: 'expense'
|
|
1609
|
+
}
|
|
1610
|
+
},
|
|
1611
|
+
required: ['type', 'flow']
|
|
1612
|
+
} as const;
|
|
1613
|
+
|
|
1400
1614
|
export const $TransactionListResponseDto = {
|
|
1401
1615
|
type: 'object',
|
|
1402
1616
|
properties: {
|
|
@@ -1404,7 +1618,7 @@ export const $TransactionListResponseDto = {
|
|
|
1404
1618
|
description: 'List of transactions',
|
|
1405
1619
|
type: 'array',
|
|
1406
1620
|
items: {
|
|
1407
|
-
$ref: '#/components/schemas/
|
|
1621
|
+
$ref: '#/components/schemas/TransactionListItemDto'
|
|
1408
1622
|
}
|
|
1409
1623
|
},
|
|
1410
1624
|
total: {
|
|
@@ -1430,6 +1644,15 @@ export const $TransactionListResponseDto = {
|
|
|
1430
1644
|
$ref: '#/components/schemas/TransactionListSummaryDto'
|
|
1431
1645
|
}
|
|
1432
1646
|
]
|
|
1647
|
+
},
|
|
1648
|
+
viewpoint: {
|
|
1649
|
+
description:
|
|
1650
|
+
'Viewpoint metadata (ADR-0126). Present only for a single category filter (category + flow, no accountId); dual-perspective requests are viewpoint-less (raw signs, no viewpointAmount).',
|
|
1651
|
+
allOf: [
|
|
1652
|
+
{
|
|
1653
|
+
$ref: '#/components/schemas/TransactionListViewpointDto'
|
|
1654
|
+
}
|
|
1655
|
+
]
|
|
1433
1656
|
}
|
|
1434
1657
|
},
|
|
1435
1658
|
required: ['data', 'total', 'limit', 'offset']
|
|
@@ -2340,10 +2563,10 @@ export const $UpdatePayeeDto = {
|
|
|
2340
2563
|
meta: {
|
|
2341
2564
|
type: 'object',
|
|
2342
2565
|
description:
|
|
2343
|
-
'Metadata for extended information (location, notes, contact info, etc.)
|
|
2566
|
+
'Metadata for extended information (location, notes, contact info, etc.)',
|
|
2344
2567
|
example: {
|
|
2345
2568
|
location: 'Zhongguancun',
|
|
2346
|
-
note: '
|
|
2569
|
+
note: 'Near subway station',
|
|
2347
2570
|
favorite: true
|
|
2348
2571
|
}
|
|
2349
2572
|
},
|
|
@@ -2904,568 +3127,660 @@ export const $UpdateCommodityDto = {
|
|
|
2904
3127
|
}
|
|
2905
3128
|
} as const;
|
|
2906
3129
|
|
|
2907
|
-
export const $
|
|
3130
|
+
export const $CurrencyBalanceDto = {
|
|
2908
3131
|
type: 'object',
|
|
2909
3132
|
properties: {
|
|
2910
3133
|
currency: {
|
|
2911
3134
|
type: 'string',
|
|
2912
|
-
description: '
|
|
2913
|
-
example: 'USD'
|
|
2914
|
-
},
|
|
2915
|
-
quoteCurrency: {
|
|
2916
|
-
type: 'string',
|
|
2917
|
-
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
3135
|
+
description: 'ISO 4217 currency code',
|
|
2918
3136
|
example: 'CNY'
|
|
2919
3137
|
},
|
|
2920
|
-
|
|
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: {
|
|
3138
|
+
balance: {
|
|
2928
3139
|
type: 'string',
|
|
2929
|
-
description: '
|
|
2930
|
-
example: '
|
|
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
|
-
}
|
|
3140
|
+
description: 'Balance amount',
|
|
3141
|
+
example: '500000.00'
|
|
2941
3142
|
}
|
|
2942
3143
|
},
|
|
2943
|
-
required: ['currency', '
|
|
3144
|
+
required: ['currency', 'balance']
|
|
2944
3145
|
} as const;
|
|
2945
3146
|
|
|
2946
|
-
export const $
|
|
3147
|
+
export const $TimeSeriesPointDto = {
|
|
2947
3148
|
type: 'object',
|
|
2948
3149
|
properties: {
|
|
2949
|
-
|
|
3150
|
+
date: {
|
|
2950
3151
|
type: 'string',
|
|
2951
|
-
description: '
|
|
2952
|
-
example: '
|
|
3152
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3153
|
+
example: '2024-06-15'
|
|
2953
3154
|
},
|
|
2954
|
-
|
|
3155
|
+
value: {
|
|
2955
3156
|
type: 'string',
|
|
2956
|
-
description: '
|
|
2957
|
-
example: '
|
|
3157
|
+
description: 'Value at this date (in base currency)',
|
|
3158
|
+
example: '500000.00'
|
|
2958
3159
|
},
|
|
2959
|
-
|
|
3160
|
+
change: {
|
|
2960
3161
|
type: 'string',
|
|
2961
|
-
description: '
|
|
2962
|
-
example: '
|
|
3162
|
+
description: 'Change from previous point',
|
|
3163
|
+
example: '5000.00'
|
|
2963
3164
|
},
|
|
2964
|
-
|
|
3165
|
+
assets: {
|
|
2965
3166
|
type: 'string',
|
|
2966
|
-
description: '
|
|
2967
|
-
example: '
|
|
3167
|
+
description: 'Total assets at this date (in base currency)',
|
|
3168
|
+
example: '494338.00'
|
|
2968
3169
|
},
|
|
2969
|
-
|
|
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: {
|
|
3170
|
+
liabilities: {
|
|
2976
3171
|
type: 'string',
|
|
2977
|
-
description:
|
|
2978
|
-
|
|
2979
|
-
example: '2024-01-01',
|
|
2980
|
-
format: 'date'
|
|
3172
|
+
description: 'Total liabilities at this date (in base currency)',
|
|
3173
|
+
example: '310098.00'
|
|
2981
3174
|
},
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
source: 'MANUAL',
|
|
2988
|
-
note: 'User-defined price',
|
|
2989
|
-
confidence: 1
|
|
3175
|
+
byCurrency: {
|
|
3176
|
+
description: 'Multi-currency breakdown for this point',
|
|
3177
|
+
type: 'array',
|
|
3178
|
+
items: {
|
|
3179
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
2990
3180
|
}
|
|
3181
|
+
}
|
|
3182
|
+
},
|
|
3183
|
+
required: ['date', 'value']
|
|
3184
|
+
} as const;
|
|
3185
|
+
|
|
3186
|
+
export const $TrendSummaryDto = {
|
|
3187
|
+
type: 'object',
|
|
3188
|
+
properties: {
|
|
3189
|
+
startValue: {
|
|
3190
|
+
type: 'string',
|
|
3191
|
+
description: 'Value at start of period',
|
|
3192
|
+
example: '450000.00'
|
|
2991
3193
|
},
|
|
2992
|
-
|
|
2993
|
-
format: 'date-time',
|
|
3194
|
+
endValue: {
|
|
2994
3195
|
type: 'string',
|
|
2995
|
-
description: '
|
|
2996
|
-
example: '
|
|
3196
|
+
description: 'Value at end of period',
|
|
3197
|
+
example: '500000.00'
|
|
2997
3198
|
},
|
|
2998
|
-
|
|
2999
|
-
format: 'date-time',
|
|
3199
|
+
totalChange: {
|
|
3000
3200
|
type: 'string',
|
|
3001
|
-
description: '
|
|
3002
|
-
example: '
|
|
3201
|
+
description: 'Total change over period',
|
|
3202
|
+
example: '50000.00'
|
|
3203
|
+
},
|
|
3204
|
+
totalChangePercentage: {
|
|
3205
|
+
type: 'string',
|
|
3206
|
+
description: 'Total change percentage',
|
|
3207
|
+
example: '+11.11%'
|
|
3003
3208
|
}
|
|
3004
3209
|
},
|
|
3005
|
-
required: [
|
|
3006
|
-
'id',
|
|
3007
|
-
'userId',
|
|
3008
|
-
'currency',
|
|
3009
|
-
'quoteCurrency',
|
|
3010
|
-
'amount',
|
|
3011
|
-
'date',
|
|
3012
|
-
'meta',
|
|
3013
|
-
'createdAt',
|
|
3014
|
-
'updatedAt'
|
|
3015
|
-
]
|
|
3210
|
+
required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
|
|
3016
3211
|
} as const;
|
|
3017
3212
|
|
|
3018
|
-
export const $
|
|
3213
|
+
export const $MultiCurrencyPointDto = {
|
|
3019
3214
|
type: 'object',
|
|
3020
3215
|
properties: {
|
|
3021
|
-
|
|
3022
|
-
|
|
3216
|
+
date: {
|
|
3217
|
+
type: 'string',
|
|
3218
|
+
description: 'Date in YYYY-MM-DD format',
|
|
3219
|
+
example: '2024-06-15'
|
|
3220
|
+
},
|
|
3221
|
+
byCurrency: {
|
|
3222
|
+
description: 'Balances by currency',
|
|
3023
3223
|
type: 'array',
|
|
3024
3224
|
items: {
|
|
3025
|
-
$ref: '#/components/schemas/
|
|
3225
|
+
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3026
3226
|
}
|
|
3027
|
-
},
|
|
3028
|
-
total: {
|
|
3029
|
-
type: 'number',
|
|
3030
|
-
description: 'Total number of prices',
|
|
3031
|
-
example: 42
|
|
3032
3227
|
}
|
|
3033
3228
|
},
|
|
3034
|
-
required: ['
|
|
3229
|
+
required: ['date', 'byCurrency']
|
|
3035
3230
|
} as const;
|
|
3036
3231
|
|
|
3037
|
-
export const $
|
|
3232
|
+
export const $PortfolioTrendsResponseDto = {
|
|
3038
3233
|
type: 'object',
|
|
3039
3234
|
properties: {
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3235
|
+
series: {
|
|
3236
|
+
description: 'Time series data points',
|
|
3237
|
+
type: 'array',
|
|
3238
|
+
items: {
|
|
3239
|
+
$ref: '#/components/schemas/TimeSeriesPointDto'
|
|
3240
|
+
}
|
|
3043
3241
|
},
|
|
3044
|
-
|
|
3242
|
+
summary: {
|
|
3243
|
+
description: 'Period summary',
|
|
3244
|
+
allOf: [
|
|
3245
|
+
{
|
|
3246
|
+
$ref: '#/components/schemas/TrendSummaryDto'
|
|
3247
|
+
}
|
|
3248
|
+
]
|
|
3249
|
+
},
|
|
3250
|
+
period: {
|
|
3045
3251
|
type: 'string',
|
|
3046
|
-
description: '
|
|
3252
|
+
description: 'Period requested',
|
|
3253
|
+
example: '6m'
|
|
3047
3254
|
},
|
|
3048
|
-
|
|
3049
|
-
type: '
|
|
3050
|
-
description: '
|
|
3051
|
-
|
|
3255
|
+
granularity: {
|
|
3256
|
+
type: 'string',
|
|
3257
|
+
description: 'Data granularity',
|
|
3258
|
+
example: 'month'
|
|
3052
3259
|
},
|
|
3053
|
-
|
|
3260
|
+
currency: {
|
|
3054
3261
|
type: 'string',
|
|
3055
|
-
description: '
|
|
3262
|
+
description: 'Base currency for converted values',
|
|
3263
|
+
example: 'CNY'
|
|
3056
3264
|
},
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3265
|
+
byCurrency: {
|
|
3266
|
+
description:
|
|
3267
|
+
'Multi-currency time series (each point has currency breakdown)',
|
|
3268
|
+
type: 'array',
|
|
3269
|
+
items: {
|
|
3270
|
+
$ref: '#/components/schemas/MultiCurrencyPointDto'
|
|
3271
|
+
}
|
|
3272
|
+
},
|
|
3273
|
+
warnings: {
|
|
3274
|
+
description: 'Exchange rate warnings',
|
|
3275
|
+
type: 'array',
|
|
3276
|
+
items: {
|
|
3277
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
3278
|
+
}
|
|
3060
3279
|
}
|
|
3061
|
-
}
|
|
3280
|
+
},
|
|
3281
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
3062
3282
|
} as const;
|
|
3063
3283
|
|
|
3064
|
-
export const $
|
|
3284
|
+
export const $CashFlowPointDto = {
|
|
3065
3285
|
type: 'object',
|
|
3066
3286
|
properties: {
|
|
3067
|
-
|
|
3068
|
-
type: 'string',
|
|
3069
|
-
description: 'Rule name (unique per user)',
|
|
3070
|
-
maxLength: 100
|
|
3071
|
-
},
|
|
3072
|
-
icon: {
|
|
3073
|
-
type: 'string',
|
|
3074
|
-
description: 'Icon emoji',
|
|
3075
|
-
maxLength: 10
|
|
3076
|
-
},
|
|
3077
|
-
frequency: {
|
|
3287
|
+
month: {
|
|
3078
3288
|
type: 'string',
|
|
3079
|
-
description: '
|
|
3080
|
-
|
|
3081
|
-
'WEEKLY',
|
|
3082
|
-
'BIWEEKLY',
|
|
3083
|
-
'MONTHLY',
|
|
3084
|
-
'BIMONTHLY',
|
|
3085
|
-
'QUARTERLY',
|
|
3086
|
-
'YEARLY',
|
|
3087
|
-
'CUSTOM'
|
|
3088
|
-
]
|
|
3089
|
-
},
|
|
3090
|
-
expectedAmount: {
|
|
3091
|
-
type: 'number',
|
|
3092
|
-
description: 'Expected amount (positive number)',
|
|
3093
|
-
minimum: 0
|
|
3094
|
-
},
|
|
3095
|
-
expectedDay: {
|
|
3096
|
-
type: 'number',
|
|
3097
|
-
description: 'Expected day of month (1-31)',
|
|
3098
|
-
minimum: 1,
|
|
3099
|
-
maximum: 31
|
|
3100
|
-
},
|
|
3101
|
-
customIntervalDays: {
|
|
3102
|
-
type: 'number',
|
|
3103
|
-
description: 'Custom interval in days (required for CUSTOM frequency)',
|
|
3104
|
-
minimum: 1
|
|
3289
|
+
description: 'Month key (YYYY-MM)',
|
|
3290
|
+
example: '2024-03'
|
|
3105
3291
|
},
|
|
3106
|
-
|
|
3292
|
+
income: {
|
|
3107
3293
|
type: 'string',
|
|
3108
|
-
description: '
|
|
3109
|
-
|
|
3110
|
-
maxLength: 10
|
|
3294
|
+
description: 'Income in base currency (absolute, converted)',
|
|
3295
|
+
example: '10000.00'
|
|
3111
3296
|
},
|
|
3112
|
-
|
|
3297
|
+
expense: {
|
|
3113
3298
|
type: 'string',
|
|
3114
|
-
description: '
|
|
3115
|
-
|
|
3116
|
-
},
|
|
3117
|
-
matchAmountTolerance: {
|
|
3118
|
-
type: 'number',
|
|
3119
|
-
description: 'Amount tolerance percentage (0-1)',
|
|
3120
|
-
default: 0.075,
|
|
3121
|
-
minimum: 0,
|
|
3122
|
-
maximum: 1
|
|
3299
|
+
description: 'Expense in base currency (absolute, converted)',
|
|
3300
|
+
example: '5000.00'
|
|
3123
3301
|
},
|
|
3124
|
-
|
|
3302
|
+
netSavings: {
|
|
3125
3303
|
type: 'string',
|
|
3126
|
-
description: '
|
|
3127
|
-
|
|
3128
|
-
}
|
|
3129
|
-
|
|
3304
|
+
description: 'netSavings = income − expense (savings positive)',
|
|
3305
|
+
example: '5000.00'
|
|
3306
|
+
}
|
|
3307
|
+
},
|
|
3308
|
+
required: ['month', 'income', 'expense', 'netSavings']
|
|
3309
|
+
} as const;
|
|
3310
|
+
|
|
3311
|
+
export const $CashFlowTrendSummaryDto = {
|
|
3312
|
+
type: 'object',
|
|
3313
|
+
properties: {
|
|
3314
|
+
totalIncome: {
|
|
3130
3315
|
type: 'string',
|
|
3131
|
-
description: '
|
|
3132
|
-
|
|
3316
|
+
description: 'Total income across the period',
|
|
3317
|
+
example: '60000.00'
|
|
3133
3318
|
},
|
|
3134
|
-
|
|
3319
|
+
totalExpense: {
|
|
3135
3320
|
type: 'string',
|
|
3136
|
-
description: '
|
|
3137
|
-
|
|
3138
|
-
},
|
|
3139
|
-
autoCreate: {
|
|
3140
|
-
type: 'boolean',
|
|
3141
|
-
description: 'Auto-create transaction when expected date arrives',
|
|
3142
|
-
default: false
|
|
3321
|
+
description: 'Total expense across the period',
|
|
3322
|
+
example: '30000.00'
|
|
3143
3323
|
},
|
|
3144
|
-
|
|
3324
|
+
totalNetSavings: {
|
|
3145
3325
|
type: 'string',
|
|
3146
|
-
description: '
|
|
3326
|
+
description: 'income − expense across the period',
|
|
3327
|
+
example: '30000.00'
|
|
3147
3328
|
},
|
|
3148
|
-
|
|
3329
|
+
averageMonthlyNetSavings: {
|
|
3149
3330
|
type: 'string',
|
|
3150
|
-
description:
|
|
3331
|
+
description:
|
|
3332
|
+
'totalNetSavings divided by the window length (N months, incl. zero-filled)',
|
|
3333
|
+
example: '5000.00'
|
|
3151
3334
|
}
|
|
3152
3335
|
},
|
|
3153
3336
|
required: [
|
|
3154
|
-
'
|
|
3155
|
-
'
|
|
3156
|
-
'
|
|
3157
|
-
'
|
|
3158
|
-
'matchAmountTolerance',
|
|
3159
|
-
'autoCreate'
|
|
3337
|
+
'totalIncome',
|
|
3338
|
+
'totalExpense',
|
|
3339
|
+
'totalNetSavings',
|
|
3340
|
+
'averageMonthlyNetSavings'
|
|
3160
3341
|
]
|
|
3161
3342
|
} as const;
|
|
3162
3343
|
|
|
3163
|
-
export const $
|
|
3344
|
+
export const $CashFlowTrendsResponseDto = {
|
|
3164
3345
|
type: 'object',
|
|
3165
3346
|
properties: {
|
|
3166
|
-
|
|
3167
|
-
|
|
3168
|
-
|
|
3347
|
+
series: {
|
|
3348
|
+
description:
|
|
3349
|
+
'Monthly cash-flow series (fixed N-month window, zero-filled)',
|
|
3350
|
+
type: 'array',
|
|
3351
|
+
items: {
|
|
3352
|
+
$ref: '#/components/schemas/CashFlowPointDto'
|
|
3353
|
+
}
|
|
3169
3354
|
},
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3355
|
+
summary: {
|
|
3356
|
+
description: 'Period totals',
|
|
3357
|
+
allOf: [
|
|
3358
|
+
{
|
|
3359
|
+
$ref: '#/components/schemas/CashFlowTrendSummaryDto'
|
|
3360
|
+
}
|
|
3361
|
+
]
|
|
3173
3362
|
},
|
|
3174
|
-
|
|
3363
|
+
period: {
|
|
3175
3364
|
type: 'string',
|
|
3176
|
-
description: '
|
|
3177
|
-
|
|
3178
|
-
icon: {
|
|
3179
|
-
type: 'object',
|
|
3180
|
-
description: 'Icon emoji'
|
|
3365
|
+
description: 'Period requested',
|
|
3366
|
+
example: '6m'
|
|
3181
3367
|
},
|
|
3182
|
-
|
|
3368
|
+
granularity: {
|
|
3183
3369
|
type: 'string',
|
|
3184
|
-
description: '
|
|
3185
|
-
|
|
3186
|
-
expectedAmount: {
|
|
3187
|
-
type: 'number',
|
|
3188
|
-
description: 'Expected amount'
|
|
3189
|
-
},
|
|
3190
|
-
expectedDay: {
|
|
3191
|
-
type: 'object',
|
|
3192
|
-
description: 'Expected day of month'
|
|
3370
|
+
description: 'Data granularity (v1 returns month buckets)',
|
|
3371
|
+
example: 'month'
|
|
3193
3372
|
},
|
|
3194
|
-
|
|
3195
|
-
type: '
|
|
3196
|
-
description: '
|
|
3373
|
+
currency: {
|
|
3374
|
+
type: 'string',
|
|
3375
|
+
description: 'Base currency for converted values',
|
|
3376
|
+
example: 'CNY'
|
|
3197
3377
|
},
|
|
3378
|
+
warnings: {
|
|
3379
|
+
description: 'Exchange rate warnings (e.g. missing rate for a currency)',
|
|
3380
|
+
type: 'array',
|
|
3381
|
+
items: {
|
|
3382
|
+
$ref: '#/components/schemas/ExchangeRateWarningDto'
|
|
3383
|
+
}
|
|
3384
|
+
}
|
|
3385
|
+
},
|
|
3386
|
+
required: ['series', 'summary', 'period', 'granularity', 'currency']
|
|
3387
|
+
} as const;
|
|
3388
|
+
|
|
3389
|
+
export const $GenerateSnapshotBody = {
|
|
3390
|
+
type: 'object',
|
|
3391
|
+
properties: {}
|
|
3392
|
+
} as const;
|
|
3393
|
+
|
|
3394
|
+
export const $GenerateSnapshotResponse = {
|
|
3395
|
+
type: 'object',
|
|
3396
|
+
properties: {}
|
|
3397
|
+
} as const;
|
|
3398
|
+
|
|
3399
|
+
export const $BackfillSnapshotsBody = {
|
|
3400
|
+
type: 'object',
|
|
3401
|
+
properties: {}
|
|
3402
|
+
} as const;
|
|
3403
|
+
|
|
3404
|
+
export const $BackfillSnapshotsResponse = {
|
|
3405
|
+
type: 'object',
|
|
3406
|
+
properties: {}
|
|
3407
|
+
} as const;
|
|
3408
|
+
|
|
3409
|
+
export const $CreateBeanPriceDto = {
|
|
3410
|
+
type: 'object',
|
|
3411
|
+
properties: {
|
|
3198
3412
|
currency: {
|
|
3199
3413
|
type: 'string',
|
|
3200
|
-
description: 'Currency
|
|
3414
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
3415
|
+
example: 'USD'
|
|
3201
3416
|
},
|
|
3202
|
-
|
|
3203
|
-
type: '
|
|
3204
|
-
description: '
|
|
3417
|
+
quoteCurrency: {
|
|
3418
|
+
type: 'string',
|
|
3419
|
+
description: 'Quote currency (pricing currency, e.g., CNY, EUR)',
|
|
3420
|
+
example: 'CNY'
|
|
3205
3421
|
},
|
|
3206
|
-
|
|
3422
|
+
amount: {
|
|
3207
3423
|
type: 'number',
|
|
3208
|
-
description:
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
|
-
description: 'Default expense account'
|
|
3424
|
+
description:
|
|
3425
|
+
'Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.',
|
|
3426
|
+
example: 175.5,
|
|
3427
|
+
minimum: 0
|
|
3213
3428
|
},
|
|
3214
|
-
|
|
3215
|
-
type: '
|
|
3216
|
-
description: '
|
|
3429
|
+
date: {
|
|
3430
|
+
type: 'string',
|
|
3431
|
+
description: 'Price date (ISO 8601 format)',
|
|
3432
|
+
example: '2024-11-05'
|
|
3217
3433
|
},
|
|
3218
|
-
|
|
3434
|
+
metadata: {
|
|
3219
3435
|
type: 'object',
|
|
3220
|
-
description:
|
|
3436
|
+
description:
|
|
3437
|
+
'Metadata (validated by Zod schema, max field lengths enforced)',
|
|
3438
|
+
example: {
|
|
3439
|
+
source: 'MANUAL',
|
|
3440
|
+
note: 'Bank valuation report',
|
|
3441
|
+
confidence: 0.95
|
|
3442
|
+
}
|
|
3443
|
+
}
|
|
3444
|
+
},
|
|
3445
|
+
required: ['currency', 'quoteCurrency', 'amount', 'date']
|
|
3446
|
+
} as const;
|
|
3447
|
+
|
|
3448
|
+
export const $PriceResponseDto = {
|
|
3449
|
+
type: 'object',
|
|
3450
|
+
properties: {
|
|
3451
|
+
id: {
|
|
3452
|
+
type: 'string',
|
|
3453
|
+
description: 'Unique identifier',
|
|
3454
|
+
example: 'uuid-123-456'
|
|
3221
3455
|
},
|
|
3222
|
-
|
|
3223
|
-
type: '
|
|
3224
|
-
description: '
|
|
3456
|
+
userId: {
|
|
3457
|
+
type: 'string',
|
|
3458
|
+
description: 'User ID (owner of the price)',
|
|
3459
|
+
example: 'user-123'
|
|
3225
3460
|
},
|
|
3226
|
-
|
|
3461
|
+
currency: {
|
|
3227
3462
|
type: 'string',
|
|
3228
|
-
description: '
|
|
3463
|
+
description: 'Currency being priced (e.g., USD, AAPL, BTC)',
|
|
3464
|
+
example: 'BTC'
|
|
3229
3465
|
},
|
|
3230
|
-
|
|
3231
|
-
type: '
|
|
3232
|
-
description: '
|
|
3466
|
+
quoteCurrency: {
|
|
3467
|
+
type: 'string',
|
|
3468
|
+
description: 'Quote currency (pricing currency, e.g., USD, CNY)',
|
|
3469
|
+
example: 'USD'
|
|
3233
3470
|
},
|
|
3234
|
-
|
|
3235
|
-
type: '
|
|
3236
|
-
description:
|
|
3471
|
+
amount: {
|
|
3472
|
+
type: 'number',
|
|
3473
|
+
description:
|
|
3474
|
+
'Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.',
|
|
3475
|
+
example: 50000
|
|
3237
3476
|
},
|
|
3238
|
-
|
|
3239
|
-
type: '
|
|
3240
|
-
description:
|
|
3477
|
+
date: {
|
|
3478
|
+
type: 'string',
|
|
3479
|
+
description:
|
|
3480
|
+
'Price date (ISO 8601 format). Represents the date this price was valid.',
|
|
3481
|
+
example: '2024-01-01',
|
|
3482
|
+
format: 'date'
|
|
3241
3483
|
},
|
|
3242
|
-
|
|
3243
|
-
type: '
|
|
3244
|
-
description:
|
|
3484
|
+
meta: {
|
|
3485
|
+
type: 'object',
|
|
3486
|
+
description:
|
|
3487
|
+
'Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.',
|
|
3488
|
+
example: {
|
|
3489
|
+
source: 'MANUAL',
|
|
3490
|
+
note: 'User-defined price',
|
|
3491
|
+
confidence: 1
|
|
3492
|
+
}
|
|
3245
3493
|
},
|
|
3246
3494
|
createdAt: {
|
|
3247
3495
|
format: 'date-time',
|
|
3248
3496
|
type: 'string',
|
|
3249
|
-
description: '
|
|
3497
|
+
description: 'Creation timestamp',
|
|
3498
|
+
example: '2024-11-03T10:00:00Z'
|
|
3250
3499
|
},
|
|
3251
3500
|
updatedAt: {
|
|
3252
3501
|
format: 'date-time',
|
|
3253
3502
|
type: 'string',
|
|
3254
|
-
description: '
|
|
3503
|
+
description: 'Last update timestamp',
|
|
3504
|
+
example: '2024-11-03T10:00:00Z'
|
|
3255
3505
|
}
|
|
3256
3506
|
},
|
|
3257
3507
|
required: [
|
|
3258
3508
|
'id',
|
|
3259
3509
|
'userId',
|
|
3260
|
-
'name',
|
|
3261
|
-
'frequency',
|
|
3262
|
-
'expectedAmount',
|
|
3263
3510
|
'currency',
|
|
3264
|
-
'
|
|
3265
|
-
'
|
|
3266
|
-
'
|
|
3267
|
-
'
|
|
3268
|
-
'totalCount',
|
|
3511
|
+
'quoteCurrency',
|
|
3512
|
+
'amount',
|
|
3513
|
+
'date',
|
|
3514
|
+
'meta',
|
|
3269
3515
|
'createdAt',
|
|
3270
3516
|
'updatedAt'
|
|
3271
3517
|
]
|
|
3272
3518
|
} as const;
|
|
3273
3519
|
|
|
3274
|
-
export const $
|
|
3520
|
+
export const $PriceListResponseDto = {
|
|
3275
3521
|
type: 'object',
|
|
3276
3522
|
properties: {
|
|
3277
|
-
|
|
3523
|
+
items: {
|
|
3524
|
+
description: 'List of prices',
|
|
3525
|
+
type: 'array',
|
|
3526
|
+
items: {
|
|
3527
|
+
$ref: '#/components/schemas/PriceResponseDto'
|
|
3528
|
+
}
|
|
3529
|
+
},
|
|
3530
|
+
total: {
|
|
3531
|
+
type: 'number',
|
|
3532
|
+
description: 'Total number of prices',
|
|
3533
|
+
example: 42
|
|
3534
|
+
}
|
|
3535
|
+
},
|
|
3536
|
+
required: ['items', 'total']
|
|
3537
|
+
} as const;
|
|
3538
|
+
|
|
3539
|
+
export const $UpdateBeanPriceDto = {
|
|
3540
|
+
type: 'object',
|
|
3541
|
+
properties: {
|
|
3542
|
+
currency: {
|
|
3278
3543
|
type: 'string',
|
|
3279
|
-
description: '
|
|
3280
|
-
enum: [
|
|
3281
|
-
'WEEKLY',
|
|
3282
|
-
'BIWEEKLY',
|
|
3283
|
-
'MONTHLY',
|
|
3284
|
-
'BIMONTHLY',
|
|
3285
|
-
'QUARTERLY',
|
|
3286
|
-
'YEARLY',
|
|
3287
|
-
'CUSTOM'
|
|
3288
|
-
],
|
|
3289
|
-
example: 'MONTHLY'
|
|
3544
|
+
description: 'Currency being priced'
|
|
3290
3545
|
},
|
|
3291
|
-
|
|
3546
|
+
quoteCurrency: {
|
|
3292
3547
|
type: 'string',
|
|
3293
|
-
description: '
|
|
3294
|
-
maxLength: 100
|
|
3548
|
+
description: 'Quote currency (pricing currency)'
|
|
3295
3549
|
},
|
|
3296
|
-
|
|
3550
|
+
amount: {
|
|
3551
|
+
type: 'number',
|
|
3552
|
+
description: 'Price amount (MUST be >= 0 per Beancount spec)',
|
|
3553
|
+
minimum: 0
|
|
3554
|
+
},
|
|
3555
|
+
date: {
|
|
3297
3556
|
type: 'string',
|
|
3298
|
-
description: '
|
|
3299
|
-
|
|
3557
|
+
description: 'Price date (ISO 8601 format)'
|
|
3558
|
+
},
|
|
3559
|
+
metadata: {
|
|
3560
|
+
type: 'object',
|
|
3561
|
+
description: 'Metadata'
|
|
3562
|
+
}
|
|
3563
|
+
}
|
|
3564
|
+
} as const;
|
|
3565
|
+
|
|
3566
|
+
export const $DeleteOwnUserDto = {
|
|
3567
|
+
type: 'object',
|
|
3568
|
+
properties: {
|
|
3569
|
+
accessToken: {
|
|
3570
|
+
type: 'string',
|
|
3571
|
+
description: 'Access token for user verification',
|
|
3572
|
+
example: 'abc123xyz'
|
|
3300
3573
|
}
|
|
3301
3574
|
},
|
|
3302
|
-
required: ['
|
|
3575
|
+
required: ['accessToken']
|
|
3303
3576
|
} as const;
|
|
3304
3577
|
|
|
3305
|
-
export const $
|
|
3578
|
+
export const $UserSettingsResponseDto = {
|
|
3306
3579
|
type: 'object',
|
|
3307
3580
|
properties: {
|
|
3308
|
-
|
|
3581
|
+
baseCurrency: {
|
|
3309
3582
|
type: 'string',
|
|
3310
|
-
description:
|
|
3311
|
-
|
|
3312
|
-
|
|
3583
|
+
description:
|
|
3584
|
+
'Stored base currency choice (ISO 4217) for net-worth/report aggregation. null = user never chose; aggregates fall back to the region default at display time (#713).',
|
|
3585
|
+
example: 'USD',
|
|
3586
|
+
nullable: true
|
|
3587
|
+
}
|
|
3588
|
+
},
|
|
3589
|
+
required: ['baseCurrency']
|
|
3590
|
+
} as const;
|
|
3591
|
+
|
|
3592
|
+
export const $UserResponseDto = {
|
|
3593
|
+
type: 'object',
|
|
3594
|
+
properties: {
|
|
3595
|
+
id: {
|
|
3313
3596
|
type: 'string',
|
|
3314
3597
|
description: 'User ID'
|
|
3315
3598
|
},
|
|
3316
|
-
|
|
3599
|
+
role: {
|
|
3317
3600
|
type: 'string',
|
|
3318
|
-
description: '
|
|
3601
|
+
description: 'Assigned user role'
|
|
3319
3602
|
},
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3603
|
+
permissions: {
|
|
3604
|
+
description: 'Permission strings',
|
|
3605
|
+
type: 'array',
|
|
3606
|
+
items: {
|
|
3607
|
+
type: 'string'
|
|
3608
|
+
}
|
|
3323
3609
|
},
|
|
3324
|
-
|
|
3610
|
+
settings: {
|
|
3611
|
+
description: 'User settings',
|
|
3612
|
+
allOf: [
|
|
3613
|
+
{
|
|
3614
|
+
$ref: '#/components/schemas/UserSettingsResponseDto'
|
|
3615
|
+
}
|
|
3616
|
+
]
|
|
3617
|
+
}
|
|
3618
|
+
},
|
|
3619
|
+
required: ['id', 'role', 'permissions', 'settings']
|
|
3620
|
+
} as const;
|
|
3621
|
+
|
|
3622
|
+
export const $SignupDto = {
|
|
3623
|
+
type: 'object',
|
|
3624
|
+
properties: {
|
|
3625
|
+
turnstileToken: {
|
|
3325
3626
|
type: 'string',
|
|
3326
|
-
description:
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
type: 'object',
|
|
3338
|
-
description: 'Custom interval in days'
|
|
3339
|
-
},
|
|
3340
|
-
currency: {
|
|
3627
|
+
description:
|
|
3628
|
+
'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
|
|
3629
|
+
example: '0.abc123def456...'
|
|
3630
|
+
}
|
|
3631
|
+
}
|
|
3632
|
+
} as const;
|
|
3633
|
+
|
|
3634
|
+
export const $SignupResponseDto = {
|
|
3635
|
+
type: 'object',
|
|
3636
|
+
properties: {
|
|
3637
|
+
authToken: {
|
|
3341
3638
|
type: 'string',
|
|
3342
|
-
description: '
|
|
3639
|
+
description: 'JWT auth token',
|
|
3640
|
+
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
3343
3641
|
},
|
|
3344
|
-
|
|
3345
|
-
type: '
|
|
3346
|
-
description: '
|
|
3642
|
+
accessToken: {
|
|
3643
|
+
type: 'string',
|
|
3644
|
+
description: 'Auto-generated access token'
|
|
3347
3645
|
},
|
|
3348
|
-
|
|
3646
|
+
role: {
|
|
3647
|
+
type: 'string',
|
|
3648
|
+
description: 'Assigned user role',
|
|
3649
|
+
enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
|
|
3650
|
+
}
|
|
3651
|
+
},
|
|
3652
|
+
required: ['authToken', 'accessToken', 'role']
|
|
3653
|
+
} as const;
|
|
3654
|
+
|
|
3655
|
+
export const $UpdateUserSettingDto = {
|
|
3656
|
+
type: 'object',
|
|
3657
|
+
properties: {
|
|
3658
|
+
secId: {
|
|
3349
3659
|
type: 'number',
|
|
3350
|
-
description: '
|
|
3351
|
-
},
|
|
3352
|
-
defaultExpenseAccount: {
|
|
3353
|
-
type: 'object',
|
|
3354
|
-
description: 'Default expense account'
|
|
3355
|
-
},
|
|
3356
|
-
defaultPaymentAccount: {
|
|
3357
|
-
type: 'object',
|
|
3358
|
-
description: 'Default payment account'
|
|
3660
|
+
description: 'Security ID'
|
|
3359
3661
|
},
|
|
3360
|
-
|
|
3361
|
-
type: '
|
|
3362
|
-
description: '
|
|
3662
|
+
annualInterestRate: {
|
|
3663
|
+
type: 'number',
|
|
3664
|
+
description: 'Annual interest rate',
|
|
3665
|
+
example: 0.05
|
|
3363
3666
|
},
|
|
3364
|
-
|
|
3365
|
-
type: '
|
|
3366
|
-
description: '
|
|
3667
|
+
currency: {
|
|
3668
|
+
type: 'string',
|
|
3669
|
+
description: 'Currency code',
|
|
3670
|
+
example: 'USD'
|
|
3367
3671
|
},
|
|
3368
|
-
|
|
3672
|
+
baseCurrency: {
|
|
3369
3673
|
type: 'string',
|
|
3370
|
-
description: '
|
|
3674
|
+
description: 'Base currency code',
|
|
3675
|
+
example: 'USD'
|
|
3371
3676
|
},
|
|
3372
|
-
|
|
3373
|
-
type: '
|
|
3374
|
-
description: '
|
|
3677
|
+
benchmark: {
|
|
3678
|
+
type: 'string',
|
|
3679
|
+
description: 'Benchmark symbol',
|
|
3680
|
+
example: 'SPY'
|
|
3375
3681
|
},
|
|
3376
|
-
|
|
3377
|
-
type: '
|
|
3378
|
-
description: '
|
|
3682
|
+
colorScheme: {
|
|
3683
|
+
type: 'string',
|
|
3684
|
+
description: 'Color scheme',
|
|
3685
|
+
enum: ['DARK', 'LIGHT']
|
|
3379
3686
|
},
|
|
3380
|
-
|
|
3381
|
-
type: '
|
|
3382
|
-
description: '
|
|
3687
|
+
dateRange: {
|
|
3688
|
+
type: 'string',
|
|
3689
|
+
description: 'Date range filter',
|
|
3690
|
+
example: '1y'
|
|
3383
3691
|
},
|
|
3384
|
-
|
|
3692
|
+
emergencyFund: {
|
|
3385
3693
|
type: 'number',
|
|
3386
|
-
description: '
|
|
3694
|
+
description: 'Emergency fund amount',
|
|
3695
|
+
example: 10000
|
|
3387
3696
|
},
|
|
3388
|
-
|
|
3389
|
-
|
|
3697
|
+
'filters.accounts': {
|
|
3698
|
+
description: 'Account filter IDs',
|
|
3699
|
+
type: 'array',
|
|
3700
|
+
items: {
|
|
3701
|
+
type: 'string'
|
|
3702
|
+
}
|
|
3703
|
+
},
|
|
3704
|
+
'filters.assetClasses': {
|
|
3705
|
+
description: 'Asset class filters',
|
|
3706
|
+
type: 'array',
|
|
3707
|
+
items: {
|
|
3708
|
+
type: 'string'
|
|
3709
|
+
}
|
|
3710
|
+
},
|
|
3711
|
+
'filters.dataSource': {
|
|
3390
3712
|
type: 'string',
|
|
3391
|
-
description: '
|
|
3713
|
+
description: 'Data source filter'
|
|
3392
3714
|
},
|
|
3393
|
-
|
|
3394
|
-
format: 'date-time',
|
|
3715
|
+
'filters.symbol': {
|
|
3395
3716
|
type: 'string',
|
|
3396
|
-
description: '
|
|
3717
|
+
description: 'Symbol filter'
|
|
3397
3718
|
},
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
|
|
3719
|
+
'filters.tags': {
|
|
3720
|
+
description: 'Tag filters',
|
|
3721
|
+
type: 'array',
|
|
3722
|
+
items: {
|
|
3723
|
+
type: 'string'
|
|
3724
|
+
}
|
|
3401
3725
|
},
|
|
3402
|
-
|
|
3403
|
-
type: '
|
|
3404
|
-
description: '
|
|
3726
|
+
isExperimentalFeatures: {
|
|
3727
|
+
type: 'boolean',
|
|
3728
|
+
description: 'Enable experimental features'
|
|
3405
3729
|
},
|
|
3406
|
-
|
|
3407
|
-
type: '
|
|
3408
|
-
description: '
|
|
3730
|
+
isRestrictedView: {
|
|
3731
|
+
type: 'boolean',
|
|
3732
|
+
description: 'Enable restricted view mode'
|
|
3409
3733
|
},
|
|
3410
|
-
|
|
3411
|
-
type: '
|
|
3412
|
-
description: '
|
|
3734
|
+
language: {
|
|
3735
|
+
type: 'string',
|
|
3736
|
+
description: 'Language code',
|
|
3737
|
+
example: 'en'
|
|
3413
3738
|
},
|
|
3414
|
-
|
|
3415
|
-
type: '
|
|
3416
|
-
description: '
|
|
3739
|
+
locale: {
|
|
3740
|
+
type: 'string',
|
|
3741
|
+
description: 'Locale code',
|
|
3742
|
+
example: 'en-US'
|
|
3417
3743
|
},
|
|
3418
|
-
|
|
3744
|
+
projectedTotalAmount: {
|
|
3419
3745
|
type: 'number',
|
|
3420
|
-
description: '
|
|
3421
|
-
|
|
3422
|
-
firstDate: {
|
|
3423
|
-
type: 'object',
|
|
3424
|
-
description: 'First matched transaction date (YYYY-MM-DD)'
|
|
3746
|
+
description: 'Projected total amount',
|
|
3747
|
+
example: 1000000
|
|
3425
3748
|
},
|
|
3426
|
-
|
|
3427
|
-
type: '
|
|
3428
|
-
description: '
|
|
3749
|
+
retirementDate: {
|
|
3750
|
+
type: 'string',
|
|
3751
|
+
description: 'Retirement date in ISO 8601 format',
|
|
3752
|
+
example: '2050-01-01'
|
|
3429
3753
|
},
|
|
3430
|
-
|
|
3754
|
+
savingsRate: {
|
|
3431
3755
|
type: 'number',
|
|
3432
|
-
description: '
|
|
3756
|
+
description: 'Savings rate percentage',
|
|
3757
|
+
example: 0.2
|
|
3433
3758
|
},
|
|
3434
|
-
|
|
3435
|
-
type: '
|
|
3436
|
-
description: '
|
|
3759
|
+
viewMode: {
|
|
3760
|
+
type: 'string',
|
|
3761
|
+
description: 'View mode',
|
|
3762
|
+
enum: ['DEFAULT', 'ZEN']
|
|
3763
|
+
}
|
|
3764
|
+
}
|
|
3765
|
+
} as const;
|
|
3766
|
+
|
|
3767
|
+
export const $UpdatePropertyDto = {
|
|
3768
|
+
type: 'object',
|
|
3769
|
+
properties: {
|
|
3770
|
+
value: {
|
|
3771
|
+
type: 'string',
|
|
3772
|
+
description: 'Property value'
|
|
3437
3773
|
}
|
|
3438
3774
|
},
|
|
3439
|
-
required: [
|
|
3440
|
-
'id',
|
|
3441
|
-
'userId',
|
|
3442
|
-
'name',
|
|
3443
|
-
'frequency',
|
|
3444
|
-
'expectedAmount',
|
|
3445
|
-
'currency',
|
|
3446
|
-
'matchAmountTolerance',
|
|
3447
|
-
'isActive',
|
|
3448
|
-
'startDate',
|
|
3449
|
-
'autoCreate',
|
|
3450
|
-
'totalCount',
|
|
3451
|
-
'createdAt',
|
|
3452
|
-
'updatedAt',
|
|
3453
|
-
'pendingCount',
|
|
3454
|
-
'overdueCount',
|
|
3455
|
-
'totalAmount',
|
|
3456
|
-
'averageAmount',
|
|
3457
|
-
'transactionCount',
|
|
3458
|
-
'variance',
|
|
3459
|
-
'upcomingCount'
|
|
3460
|
-
]
|
|
3775
|
+
required: ['value']
|
|
3461
3776
|
} as const;
|
|
3462
3777
|
|
|
3463
|
-
export const $
|
|
3778
|
+
export const $CreateRecurringRuleDto = {
|
|
3464
3779
|
type: 'object',
|
|
3465
3780
|
properties: {
|
|
3466
3781
|
name: {
|
|
3467
3782
|
type: 'string',
|
|
3468
|
-
description: 'Rule name',
|
|
3783
|
+
description: 'Rule name (unique per user)',
|
|
3469
3784
|
maxLength: 100
|
|
3470
3785
|
},
|
|
3471
3786
|
icon: {
|
|
@@ -3488,7 +3803,7 @@ export const $UpdateRecurringRuleDto = {
|
|
|
3488
3803
|
},
|
|
3489
3804
|
expectedAmount: {
|
|
3490
3805
|
type: 'number',
|
|
3491
|
-
description: 'Expected amount',
|
|
3806
|
+
description: 'Expected amount (positive number)',
|
|
3492
3807
|
minimum: 0
|
|
3493
3808
|
},
|
|
3494
3809
|
expectedDay: {
|
|
@@ -3499,7 +3814,7 @@ export const $UpdateRecurringRuleDto = {
|
|
|
3499
3814
|
},
|
|
3500
3815
|
customIntervalDays: {
|
|
3501
3816
|
type: 'number',
|
|
3502
|
-
description: 'Custom interval in days',
|
|
3817
|
+
description: 'Custom interval in days (required for CUSTOM frequency)',
|
|
3503
3818
|
minimum: 1
|
|
3504
3819
|
},
|
|
3505
3820
|
currency: {
|
|
@@ -3509,118 +3824,136 @@ export const $UpdateRecurringRuleDto = {
|
|
|
3509
3824
|
},
|
|
3510
3825
|
matchPayeePattern: {
|
|
3511
3826
|
type: 'string',
|
|
3512
|
-
description: 'Payee matching pattern',
|
|
3827
|
+
description: 'Payee matching pattern (supports wildcards)',
|
|
3513
3828
|
maxLength: 200
|
|
3514
3829
|
},
|
|
3515
3830
|
matchAmountTolerance: {
|
|
3516
3831
|
type: 'number',
|
|
3517
3832
|
description: 'Amount tolerance percentage (0-1)',
|
|
3833
|
+
default: 0.075,
|
|
3518
3834
|
minimum: 0,
|
|
3519
3835
|
maximum: 1
|
|
3520
3836
|
},
|
|
3521
3837
|
defaultExpenseAccount: {
|
|
3522
3838
|
type: 'string',
|
|
3523
|
-
description: 'Default expense account',
|
|
3839
|
+
description: 'Default expense account for auto-create',
|
|
3524
3840
|
maxLength: 200
|
|
3525
3841
|
},
|
|
3526
3842
|
defaultPaymentAccount: {
|
|
3527
3843
|
type: 'string',
|
|
3528
|
-
description: 'Default payment account',
|
|
3844
|
+
description: 'Default payment account for auto-create',
|
|
3529
3845
|
maxLength: 200
|
|
3530
3846
|
},
|
|
3531
3847
|
defaultPayee: {
|
|
3532
3848
|
type: 'string',
|
|
3533
|
-
description: 'Default payee',
|
|
3849
|
+
description: 'Default payee for auto-create',
|
|
3534
3850
|
maxLength: 200
|
|
3535
3851
|
},
|
|
3536
3852
|
autoCreate: {
|
|
3537
3853
|
type: 'boolean',
|
|
3538
|
-
description: 'Auto-create transaction'
|
|
3854
|
+
description: 'Auto-create transaction when expected date arrives',
|
|
3855
|
+
default: false
|
|
3539
3856
|
},
|
|
3540
|
-
|
|
3541
|
-
type: '
|
|
3542
|
-
description: 'Rule
|
|
3857
|
+
startDate: {
|
|
3858
|
+
type: 'string',
|
|
3859
|
+
description: 'Rule start date (ISO format)'
|
|
3543
3860
|
},
|
|
3544
3861
|
endDate: {
|
|
3545
3862
|
type: 'string',
|
|
3546
3863
|
description: 'Rule end date (ISO format)'
|
|
3547
3864
|
}
|
|
3548
|
-
}
|
|
3865
|
+
},
|
|
3866
|
+
required: [
|
|
3867
|
+
'name',
|
|
3868
|
+
'frequency',
|
|
3869
|
+
'expectedAmount',
|
|
3870
|
+
'matchAmountTolerance',
|
|
3871
|
+
'autoCreate'
|
|
3872
|
+
]
|
|
3549
3873
|
} as const;
|
|
3550
3874
|
|
|
3551
|
-
export const $
|
|
3875
|
+
export const $RecurringRuleResponseDto = {
|
|
3552
3876
|
type: 'object',
|
|
3553
3877
|
properties: {
|
|
3878
|
+
id: {
|
|
3879
|
+
type: 'string',
|
|
3880
|
+
description: 'Rule ID'
|
|
3881
|
+
},
|
|
3882
|
+
userId: {
|
|
3883
|
+
type: 'string',
|
|
3884
|
+
description: 'User ID'
|
|
3885
|
+
},
|
|
3554
3886
|
name: {
|
|
3555
3887
|
type: 'string',
|
|
3556
3888
|
description: 'Rule name'
|
|
3557
3889
|
},
|
|
3558
3890
|
icon: {
|
|
3559
|
-
type: '
|
|
3560
|
-
description: '
|
|
3891
|
+
type: 'string',
|
|
3892
|
+
description: 'Icon emoji'
|
|
3561
3893
|
},
|
|
3562
3894
|
frequency: {
|
|
3563
3895
|
type: 'string',
|
|
3564
|
-
description: '
|
|
3896
|
+
description: 'Recurring frequency'
|
|
3897
|
+
},
|
|
3898
|
+
expectedAmount: {
|
|
3899
|
+
type: 'number',
|
|
3900
|
+
description: 'Expected amount'
|
|
3901
|
+
},
|
|
3902
|
+
expectedDay: {
|
|
3903
|
+
type: 'number',
|
|
3904
|
+
description: 'Expected day of month'
|
|
3905
|
+
},
|
|
3906
|
+
customIntervalDays: {
|
|
3907
|
+
type: 'number',
|
|
3908
|
+
description: 'Custom interval in days'
|
|
3565
3909
|
},
|
|
3566
3910
|
currency: {
|
|
3567
3911
|
type: 'string',
|
|
3568
3912
|
description: 'Currency code'
|
|
3569
|
-
}
|
|
3570
|
-
},
|
|
3571
|
-
required: ['name', 'frequency', 'currency']
|
|
3572
|
-
} as const;
|
|
3573
|
-
|
|
3574
|
-
export const $ExpectedTransactionResponseDto = {
|
|
3575
|
-
type: 'object',
|
|
3576
|
-
properties: {
|
|
3577
|
-
id: {
|
|
3578
|
-
type: 'string',
|
|
3579
|
-
description: 'Expected transaction ID'
|
|
3580
3913
|
},
|
|
3581
|
-
|
|
3914
|
+
matchPayeePattern: {
|
|
3582
3915
|
type: 'string',
|
|
3583
|
-
description: '
|
|
3916
|
+
description: 'Payee matching pattern'
|
|
3584
3917
|
},
|
|
3585
|
-
|
|
3586
|
-
type: '
|
|
3587
|
-
description: '
|
|
3918
|
+
matchAmountTolerance: {
|
|
3919
|
+
type: 'number',
|
|
3920
|
+
description: 'Amount tolerance percentage'
|
|
3588
3921
|
},
|
|
3589
|
-
|
|
3922
|
+
defaultExpenseAccount: {
|
|
3590
3923
|
type: 'string',
|
|
3591
|
-
description: '
|
|
3924
|
+
description: 'Default expense account'
|
|
3592
3925
|
},
|
|
3593
|
-
|
|
3594
|
-
type: '
|
|
3595
|
-
description: '
|
|
3926
|
+
defaultPaymentAccount: {
|
|
3927
|
+
type: 'string',
|
|
3928
|
+
description: 'Default payment account'
|
|
3596
3929
|
},
|
|
3597
|
-
|
|
3930
|
+
defaultPayee: {
|
|
3598
3931
|
type: 'string',
|
|
3599
|
-
description: '
|
|
3932
|
+
description: 'Default payee'
|
|
3600
3933
|
},
|
|
3601
|
-
|
|
3602
|
-
type: '
|
|
3603
|
-
description: '
|
|
3934
|
+
isActive: {
|
|
3935
|
+
type: 'boolean',
|
|
3936
|
+
description: 'Whether rule is active'
|
|
3604
3937
|
},
|
|
3605
|
-
|
|
3606
|
-
type: '
|
|
3607
|
-
description: '
|
|
3938
|
+
startDate: {
|
|
3939
|
+
type: 'string',
|
|
3940
|
+
description: 'Rule start date (YYYY-MM-DD)'
|
|
3608
3941
|
},
|
|
3609
|
-
|
|
3610
|
-
type: '
|
|
3611
|
-
description: '
|
|
3942
|
+
endDate: {
|
|
3943
|
+
type: 'string',
|
|
3944
|
+
description: 'Rule end date (YYYY-MM-DD)'
|
|
3612
3945
|
},
|
|
3613
|
-
|
|
3946
|
+
autoCreate: {
|
|
3614
3947
|
type: 'boolean',
|
|
3615
|
-
description: '
|
|
3948
|
+
description: 'Auto-create transaction on expected date'
|
|
3616
3949
|
},
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
|
|
3622
|
-
|
|
3623
|
-
|
|
3950
|
+
lastOccurrence: {
|
|
3951
|
+
type: 'string',
|
|
3952
|
+
description: 'Last matched occurrence date (YYYY-MM-DD)'
|
|
3953
|
+
},
|
|
3954
|
+
totalCount: {
|
|
3955
|
+
type: 'number',
|
|
3956
|
+
description: 'Total matched transactions count'
|
|
3624
3957
|
},
|
|
3625
3958
|
createdAt: {
|
|
3626
3959
|
format: 'date-time',
|
|
@@ -3636,691 +3969,581 @@ export const $ExpectedTransactionResponseDto = {
|
|
|
3636
3969
|
required: [
|
|
3637
3970
|
'id',
|
|
3638
3971
|
'userId',
|
|
3639
|
-
'
|
|
3640
|
-
'
|
|
3972
|
+
'name',
|
|
3973
|
+
'frequency',
|
|
3641
3974
|
'expectedAmount',
|
|
3642
|
-
'
|
|
3643
|
-
'
|
|
3644
|
-
'
|
|
3975
|
+
'currency',
|
|
3976
|
+
'matchAmountTolerance',
|
|
3977
|
+
'isActive',
|
|
3978
|
+
'startDate',
|
|
3979
|
+
'autoCreate',
|
|
3980
|
+
'totalCount',
|
|
3645
3981
|
'createdAt',
|
|
3646
3982
|
'updatedAt'
|
|
3647
3983
|
]
|
|
3648
3984
|
} as const;
|
|
3649
3985
|
|
|
3650
|
-
export const $
|
|
3986
|
+
export const $CreateRuleFromTransactionDto = {
|
|
3651
3987
|
type: 'object',
|
|
3652
3988
|
properties: {
|
|
3653
|
-
|
|
3654
|
-
type: '
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
|
|
3989
|
+
frequency: {
|
|
3990
|
+
type: 'string',
|
|
3991
|
+
description: 'Recurring frequency',
|
|
3992
|
+
enum: [
|
|
3993
|
+
'WEEKLY',
|
|
3994
|
+
'BIWEEKLY',
|
|
3995
|
+
'MONTHLY',
|
|
3996
|
+
'BIMONTHLY',
|
|
3997
|
+
'QUARTERLY',
|
|
3998
|
+
'YEARLY',
|
|
3999
|
+
'CUSTOM'
|
|
4000
|
+
],
|
|
4001
|
+
example: 'MONTHLY'
|
|
3658
4002
|
},
|
|
3659
|
-
|
|
3660
|
-
type: 'number',
|
|
3661
|
-
description: 'Total count'
|
|
3662
|
-
}
|
|
3663
|
-
},
|
|
3664
|
-
required: ['items', 'total']
|
|
3665
|
-
} as const;
|
|
3666
|
-
|
|
3667
|
-
export const $ConfirmMatchDto = {
|
|
3668
|
-
type: 'object',
|
|
3669
|
-
properties: {
|
|
3670
|
-
transactionId: {
|
|
4003
|
+
name: {
|
|
3671
4004
|
type: 'string',
|
|
3672
|
-
description: '
|
|
4005
|
+
description: 'Optional name override (default: transaction payee)',
|
|
4006
|
+
maxLength: 100
|
|
4007
|
+
},
|
|
4008
|
+
icon: {
|
|
4009
|
+
type: 'string',
|
|
4010
|
+
description: 'Optional icon emoji',
|
|
4011
|
+
maxLength: 10
|
|
3673
4012
|
}
|
|
3674
4013
|
},
|
|
3675
|
-
required: ['
|
|
4014
|
+
required: ['frequency']
|
|
3676
4015
|
} as const;
|
|
3677
4016
|
|
|
3678
|
-
export const $
|
|
4017
|
+
export const $RecurringRuleWithStatsResponseDto = {
|
|
3679
4018
|
type: 'object',
|
|
3680
4019
|
properties: {
|
|
3681
|
-
|
|
4020
|
+
id: {
|
|
3682
4021
|
type: 'string',
|
|
3683
|
-
description:
|
|
3684
|
-
'Override expense account (uses rule default if not provided)',
|
|
3685
|
-
maxLength: 200
|
|
4022
|
+
description: 'Rule ID'
|
|
3686
4023
|
},
|
|
3687
|
-
|
|
4024
|
+
userId: {
|
|
3688
4025
|
type: 'string',
|
|
3689
|
-
description:
|
|
3690
|
-
'Override payment account (uses rule default if not provided)',
|
|
3691
|
-
maxLength: 200
|
|
4026
|
+
description: 'User ID'
|
|
3692
4027
|
},
|
|
3693
|
-
|
|
3694
|
-
type: '
|
|
3695
|
-
description: '
|
|
3696
|
-
minimum: 0
|
|
4028
|
+
name: {
|
|
4029
|
+
type: 'string',
|
|
4030
|
+
description: 'Rule name'
|
|
3697
4031
|
},
|
|
3698
|
-
|
|
4032
|
+
icon: {
|
|
3699
4033
|
type: 'string',
|
|
3700
|
-
description: '
|
|
3701
|
-
maxLength: 200
|
|
4034
|
+
description: 'Icon emoji'
|
|
3702
4035
|
},
|
|
3703
|
-
|
|
4036
|
+
frequency: {
|
|
3704
4037
|
type: 'string',
|
|
3705
|
-
description: '
|
|
3706
|
-
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
4038
|
+
description: 'Recurring frequency'
|
|
4039
|
+
},
|
|
4040
|
+
expectedAmount: {
|
|
4041
|
+
type: 'number',
|
|
4042
|
+
description: 'Expected amount'
|
|
4043
|
+
},
|
|
4044
|
+
expectedDay: {
|
|
4045
|
+
type: 'number',
|
|
4046
|
+
description: 'Expected day of month'
|
|
4047
|
+
},
|
|
4048
|
+
customIntervalDays: {
|
|
4049
|
+
type: 'number',
|
|
4050
|
+
description: 'Custom interval in days'
|
|
4051
|
+
},
|
|
4052
|
+
currency: {
|
|
3715
4053
|
type: 'string',
|
|
3716
|
-
description: '
|
|
3717
|
-
example: 'Rent'
|
|
4054
|
+
description: 'Currency code'
|
|
3718
4055
|
},
|
|
3719
|
-
|
|
4056
|
+
matchPayeePattern: {
|
|
3720
4057
|
type: 'string',
|
|
3721
|
-
description: '
|
|
3722
|
-
example: 'clx123...'
|
|
4058
|
+
description: 'Payee matching pattern'
|
|
3723
4059
|
},
|
|
3724
|
-
|
|
4060
|
+
matchAmountTolerance: {
|
|
3725
4061
|
type: 'number',
|
|
3726
|
-
description: '
|
|
3727
|
-
example: 3000
|
|
4062
|
+
description: 'Amount tolerance percentage'
|
|
3728
4063
|
},
|
|
3729
|
-
|
|
4064
|
+
defaultExpenseAccount: {
|
|
3730
4065
|
type: 'string',
|
|
3731
|
-
description: '
|
|
3732
|
-
example: '2024-04-01'
|
|
4066
|
+
description: 'Default expense account'
|
|
3733
4067
|
},
|
|
3734
|
-
|
|
4068
|
+
defaultPaymentAccount: {
|
|
3735
4069
|
type: 'string',
|
|
3736
|
-
description: '
|
|
3737
|
-
example: '🏠',
|
|
3738
|
-
nullable: true
|
|
4070
|
+
description: 'Default payment account'
|
|
3739
4071
|
},
|
|
3740
|
-
|
|
4072
|
+
defaultPayee: {
|
|
3741
4073
|
type: 'string',
|
|
3742
|
-
description: '
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
|
|
3746
|
-
|
|
3747
|
-
}
|
|
3748
|
-
|
|
3749
|
-
export const $MonthlyForecastDto = {
|
|
3750
|
-
type: 'object',
|
|
3751
|
-
properties: {
|
|
3752
|
-
month: {
|
|
4074
|
+
description: 'Default payee'
|
|
4075
|
+
},
|
|
4076
|
+
isActive: {
|
|
4077
|
+
type: 'boolean',
|
|
4078
|
+
description: 'Whether rule is active'
|
|
4079
|
+
},
|
|
4080
|
+
startDate: {
|
|
3753
4081
|
type: 'string',
|
|
3754
|
-
description: '
|
|
3755
|
-
example: '2024-04'
|
|
4082
|
+
description: 'Rule start date (YYYY-MM-DD)'
|
|
3756
4083
|
},
|
|
3757
|
-
|
|
4084
|
+
endDate: {
|
|
4085
|
+
type: 'string',
|
|
4086
|
+
description: 'Rule end date (YYYY-MM-DD)'
|
|
4087
|
+
},
|
|
4088
|
+
autoCreate: {
|
|
4089
|
+
type: 'boolean',
|
|
4090
|
+
description: 'Auto-create transaction on expected date'
|
|
4091
|
+
},
|
|
4092
|
+
lastOccurrence: {
|
|
4093
|
+
type: 'string',
|
|
4094
|
+
description: 'Last matched occurrence date (YYYY-MM-DD)'
|
|
4095
|
+
},
|
|
4096
|
+
totalCount: {
|
|
3758
4097
|
type: 'number',
|
|
3759
|
-
description: 'Total
|
|
3760
|
-
example: 8500
|
|
4098
|
+
description: 'Total matched transactions count'
|
|
3761
4099
|
},
|
|
3762
|
-
|
|
4100
|
+
createdAt: {
|
|
4101
|
+
format: 'date-time',
|
|
4102
|
+
type: 'string',
|
|
4103
|
+
description: 'Created at timestamp'
|
|
4104
|
+
},
|
|
4105
|
+
updatedAt: {
|
|
4106
|
+
format: 'date-time',
|
|
4107
|
+
type: 'string',
|
|
4108
|
+
description: 'Updated at timestamp'
|
|
4109
|
+
},
|
|
4110
|
+
pendingCount: {
|
|
3763
4111
|
type: 'number',
|
|
3764
|
-
description: 'Number of expected transactions'
|
|
3765
|
-
example: 3
|
|
4112
|
+
description: 'Number of pending expected transactions'
|
|
3766
4113
|
},
|
|
3767
|
-
|
|
3768
|
-
type: '
|
|
3769
|
-
description: '
|
|
3770
|
-
example: {
|
|
3771
|
-
CNY: 8500,
|
|
3772
|
-
USD: 100
|
|
3773
|
-
}
|
|
4114
|
+
overdueCount: {
|
|
4115
|
+
type: 'number',
|
|
4116
|
+
description: 'Number of overdue expected transactions'
|
|
3774
4117
|
},
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
items: {
|
|
3779
|
-
$ref: '#/components/schemas/ForecastItemDto'
|
|
3780
|
-
}
|
|
3781
|
-
}
|
|
3782
|
-
},
|
|
3783
|
-
required: ['month', 'expectedOutflow', 'itemCount', 'byCurrency', 'items']
|
|
3784
|
-
} as const;
|
|
3785
|
-
|
|
3786
|
-
export const $ForecastResponseDto = {
|
|
3787
|
-
type: 'object',
|
|
3788
|
-
properties: {
|
|
3789
|
-
forecast: {
|
|
3790
|
-
description: 'Monthly forecast data',
|
|
3791
|
-
type: 'array',
|
|
3792
|
-
items: {
|
|
3793
|
-
$ref: '#/components/schemas/MonthlyForecastDto'
|
|
3794
|
-
}
|
|
4118
|
+
nextExpectedDate: {
|
|
4119
|
+
type: 'string',
|
|
4120
|
+
description: 'Next expected date (YYYY-MM-DD)'
|
|
3795
4121
|
},
|
|
3796
|
-
|
|
4122
|
+
totalAmount: {
|
|
3797
4123
|
type: 'number',
|
|
3798
|
-
description: 'Total
|
|
3799
|
-
example: 25500
|
|
4124
|
+
description: 'Total amount of all matched transactions'
|
|
3800
4125
|
},
|
|
3801
|
-
|
|
3802
|
-
type: '
|
|
3803
|
-
description: '
|
|
3804
|
-
example: {
|
|
3805
|
-
CNY: 25500,
|
|
3806
|
-
USD: 300
|
|
3807
|
-
}
|
|
4126
|
+
averageAmount: {
|
|
4127
|
+
type: 'number',
|
|
4128
|
+
description: 'Average amount per transaction'
|
|
3808
4129
|
},
|
|
3809
|
-
|
|
4130
|
+
transactionCount: {
|
|
3810
4131
|
type: 'number',
|
|
3811
|
-
description: 'Number of
|
|
3812
|
-
example: 5
|
|
4132
|
+
description: 'Number of matched transactions'
|
|
3813
4133
|
},
|
|
3814
|
-
|
|
4134
|
+
firstDate: {
|
|
3815
4135
|
type: 'string',
|
|
3816
|
-
description: '
|
|
3817
|
-
example: '2024-04-01'
|
|
4136
|
+
description: 'First matched transaction date (YYYY-MM-DD)'
|
|
3818
4137
|
},
|
|
3819
|
-
|
|
4138
|
+
lastDate: {
|
|
3820
4139
|
type: 'string',
|
|
3821
|
-
description: '
|
|
3822
|
-
|
|
4140
|
+
description: 'Last matched transaction date (YYYY-MM-DD)'
|
|
4141
|
+
},
|
|
4142
|
+
variance: {
|
|
4143
|
+
type: 'number',
|
|
4144
|
+
description: 'Amount variance (standard deviation squared)'
|
|
4145
|
+
},
|
|
4146
|
+
upcomingCount: {
|
|
4147
|
+
type: 'number',
|
|
4148
|
+
description: 'Number of upcoming expected transactions'
|
|
3823
4149
|
}
|
|
3824
4150
|
},
|
|
3825
4151
|
required: [
|
|
3826
|
-
'
|
|
3827
|
-
'
|
|
3828
|
-
'
|
|
3829
|
-
'
|
|
3830
|
-
'
|
|
3831
|
-
'
|
|
4152
|
+
'id',
|
|
4153
|
+
'userId',
|
|
4154
|
+
'name',
|
|
4155
|
+
'frequency',
|
|
4156
|
+
'expectedAmount',
|
|
4157
|
+
'currency',
|
|
4158
|
+
'matchAmountTolerance',
|
|
4159
|
+
'isActive',
|
|
4160
|
+
'startDate',
|
|
4161
|
+
'autoCreate',
|
|
4162
|
+
'totalCount',
|
|
4163
|
+
'createdAt',
|
|
4164
|
+
'updatedAt',
|
|
4165
|
+
'pendingCount',
|
|
4166
|
+
'overdueCount',
|
|
4167
|
+
'totalAmount',
|
|
4168
|
+
'averageAmount',
|
|
4169
|
+
'transactionCount',
|
|
4170
|
+
'variance',
|
|
4171
|
+
'upcomingCount'
|
|
3832
4172
|
]
|
|
3833
4173
|
} as const;
|
|
3834
4174
|
|
|
3835
|
-
export const $
|
|
4175
|
+
export const $UpdateRecurringRuleDto = {
|
|
3836
4176
|
type: 'object',
|
|
3837
4177
|
properties: {
|
|
3838
|
-
|
|
4178
|
+
name: {
|
|
3839
4179
|
type: 'string',
|
|
3840
|
-
description: '
|
|
3841
|
-
|
|
4180
|
+
description: 'Rule name (unique per user)',
|
|
4181
|
+
maxLength: 100
|
|
3842
4182
|
},
|
|
3843
|
-
|
|
3844
|
-
type: 'string',
|
|
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: {
|
|
4183
|
+
icon: {
|
|
3856
4184
|
type: 'string',
|
|
3857
|
-
description: '
|
|
3858
|
-
|
|
4185
|
+
description: 'Icon emoji',
|
|
4186
|
+
maxLength: 10
|
|
3859
4187
|
},
|
|
3860
|
-
|
|
4188
|
+
frequency: {
|
|
3861
4189
|
type: 'string',
|
|
3862
|
-
description: '
|
|
3863
|
-
|
|
4190
|
+
description: 'Recurring frequency',
|
|
4191
|
+
enum: [
|
|
4192
|
+
'WEEKLY',
|
|
4193
|
+
'BIWEEKLY',
|
|
4194
|
+
'MONTHLY',
|
|
4195
|
+
'BIMONTHLY',
|
|
4196
|
+
'QUARTERLY',
|
|
4197
|
+
'YEARLY',
|
|
4198
|
+
'CUSTOM'
|
|
4199
|
+
]
|
|
3864
4200
|
},
|
|
3865
|
-
|
|
3866
|
-
type: '
|
|
3867
|
-
description: '
|
|
3868
|
-
|
|
4201
|
+
expectedAmount: {
|
|
4202
|
+
type: 'number',
|
|
4203
|
+
description: 'Expected amount (positive number)',
|
|
4204
|
+
minimum: 0
|
|
3869
4205
|
},
|
|
3870
|
-
|
|
3871
|
-
type: '
|
|
3872
|
-
description: '
|
|
3873
|
-
|
|
4206
|
+
expectedDay: {
|
|
4207
|
+
type: 'number',
|
|
4208
|
+
description: 'Expected day of month (1-31)',
|
|
4209
|
+
minimum: 1,
|
|
4210
|
+
maximum: 31
|
|
3874
4211
|
},
|
|
3875
|
-
|
|
4212
|
+
currency: {
|
|
3876
4213
|
type: 'string',
|
|
3877
|
-
description: '
|
|
3878
|
-
|
|
4214
|
+
description: 'Currency code',
|
|
4215
|
+
maxLength: 10
|
|
3879
4216
|
},
|
|
3880
|
-
|
|
3881
|
-
description: 'Multi-currency breakdown for this point',
|
|
3882
|
-
type: 'array',
|
|
3883
|
-
items: {
|
|
3884
|
-
$ref: '#/components/schemas/CurrencyBalanceDto'
|
|
3885
|
-
}
|
|
3886
|
-
}
|
|
3887
|
-
},
|
|
3888
|
-
required: ['date', 'value']
|
|
3889
|
-
} as const;
|
|
3890
|
-
|
|
3891
|
-
export const $TrendSummaryDto = {
|
|
3892
|
-
type: 'object',
|
|
3893
|
-
properties: {
|
|
3894
|
-
startValue: {
|
|
4217
|
+
matchPayeePattern: {
|
|
3895
4218
|
type: 'string',
|
|
3896
|
-
description: '
|
|
3897
|
-
|
|
4219
|
+
description: 'Payee matching pattern (supports wildcards)',
|
|
4220
|
+
maxLength: 200
|
|
3898
4221
|
},
|
|
3899
|
-
|
|
4222
|
+
matchAmountTolerance: {
|
|
4223
|
+
type: 'number',
|
|
4224
|
+
description: 'Amount tolerance percentage (0-1)',
|
|
4225
|
+
default: 0.075,
|
|
4226
|
+
minimum: 0,
|
|
4227
|
+
maximum: 1
|
|
4228
|
+
},
|
|
4229
|
+
defaultExpenseAccount: {
|
|
3900
4230
|
type: 'string',
|
|
3901
|
-
description: '
|
|
3902
|
-
|
|
4231
|
+
description: 'Default expense account for auto-create',
|
|
4232
|
+
maxLength: 200
|
|
3903
4233
|
},
|
|
3904
|
-
|
|
4234
|
+
defaultPaymentAccount: {
|
|
3905
4235
|
type: 'string',
|
|
3906
|
-
description: '
|
|
3907
|
-
|
|
4236
|
+
description: 'Default payment account for auto-create',
|
|
4237
|
+
maxLength: 200
|
|
3908
4238
|
},
|
|
3909
|
-
|
|
4239
|
+
defaultPayee: {
|
|
3910
4240
|
type: 'string',
|
|
3911
|
-
description: '
|
|
3912
|
-
|
|
3913
|
-
}
|
|
3914
|
-
|
|
3915
|
-
|
|
3916
|
-
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
|
|
3920
|
-
properties: {
|
|
3921
|
-
date: {
|
|
4241
|
+
description: 'Default payee for auto-create',
|
|
4242
|
+
maxLength: 200
|
|
4243
|
+
},
|
|
4244
|
+
autoCreate: {
|
|
4245
|
+
type: 'boolean',
|
|
4246
|
+
description: 'Auto-create transaction when expected date arrives',
|
|
4247
|
+
default: false
|
|
4248
|
+
},
|
|
4249
|
+
endDate: {
|
|
3922
4250
|
type: 'string',
|
|
3923
|
-
description: '
|
|
3924
|
-
example: '2024-06-15'
|
|
4251
|
+
description: 'Rule end date (ISO format)'
|
|
3925
4252
|
},
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
|
-
|
|
3931
|
-
|
|
4253
|
+
customIntervalDays: {
|
|
4254
|
+
type: 'number',
|
|
4255
|
+
description: 'Custom interval in days',
|
|
4256
|
+
minimum: 1
|
|
4257
|
+
},
|
|
4258
|
+
isActive: {
|
|
4259
|
+
type: 'boolean',
|
|
4260
|
+
description: 'Rule active status'
|
|
3932
4261
|
}
|
|
3933
|
-
}
|
|
3934
|
-
required: ['date', 'byCurrency']
|
|
4262
|
+
}
|
|
3935
4263
|
} as const;
|
|
3936
4264
|
|
|
3937
|
-
export const $
|
|
4265
|
+
export const $ExpectedTransactionRuleDto = {
|
|
3938
4266
|
type: 'object',
|
|
3939
4267
|
properties: {
|
|
3940
|
-
|
|
3941
|
-
|
|
3942
|
-
|
|
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
|
-
]
|
|
4268
|
+
name: {
|
|
4269
|
+
type: 'string',
|
|
4270
|
+
description: 'Rule name'
|
|
3954
4271
|
},
|
|
3955
|
-
|
|
4272
|
+
icon: {
|
|
3956
4273
|
type: 'string',
|
|
3957
|
-
description: '
|
|
3958
|
-
example: '6m'
|
|
4274
|
+
description: 'Rule icon'
|
|
3959
4275
|
},
|
|
3960
|
-
|
|
4276
|
+
frequency: {
|
|
3961
4277
|
type: 'string',
|
|
3962
|
-
description: '
|
|
3963
|
-
example: 'month'
|
|
4278
|
+
description: 'Rule frequency'
|
|
3964
4279
|
},
|
|
3965
4280
|
currency: {
|
|
3966
4281
|
type: 'string',
|
|
3967
|
-
description: '
|
|
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
|
-
}
|
|
4282
|
+
description: 'Currency code'
|
|
3984
4283
|
}
|
|
3985
4284
|
},
|
|
3986
|
-
required: ['
|
|
4285
|
+
required: ['name', 'frequency', 'currency']
|
|
3987
4286
|
} as const;
|
|
3988
4287
|
|
|
3989
|
-
export const $
|
|
4288
|
+
export const $ExpectedTransactionResponseDto = {
|
|
3990
4289
|
type: 'object',
|
|
3991
4290
|
properties: {
|
|
3992
|
-
|
|
4291
|
+
id: {
|
|
3993
4292
|
type: 'string',
|
|
3994
|
-
description: '
|
|
3995
|
-
example: '2024-03'
|
|
4293
|
+
description: 'Expected transaction ID'
|
|
3996
4294
|
},
|
|
3997
|
-
|
|
4295
|
+
userId: {
|
|
3998
4296
|
type: 'string',
|
|
3999
|
-
description: '
|
|
4000
|
-
example: '10000.00'
|
|
4297
|
+
description: 'User ID'
|
|
4001
4298
|
},
|
|
4002
|
-
|
|
4299
|
+
ruleId: {
|
|
4003
4300
|
type: 'string',
|
|
4004
|
-
description: '
|
|
4005
|
-
example: '5000.00'
|
|
4301
|
+
description: 'Associated rule ID'
|
|
4006
4302
|
},
|
|
4007
|
-
|
|
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: {
|
|
4303
|
+
expectedDate: {
|
|
4020
4304
|
type: 'string',
|
|
4021
|
-
description: '
|
|
4022
|
-
|
|
4305
|
+
description: 'Expected date (YYYY-MM-DD)'
|
|
4306
|
+
},
|
|
4307
|
+
expectedAmount: {
|
|
4308
|
+
type: 'number',
|
|
4309
|
+
description: 'Expected amount'
|
|
4023
4310
|
},
|
|
4024
|
-
|
|
4311
|
+
status: {
|
|
4025
4312
|
type: 'string',
|
|
4026
|
-
description: '
|
|
4027
|
-
example: '30000.00'
|
|
4313
|
+
description: 'Status (PENDING, COMPLETED, SKIPPED)'
|
|
4028
4314
|
},
|
|
4029
|
-
|
|
4315
|
+
matchedTransactionId: {
|
|
4030
4316
|
type: 'string',
|
|
4031
|
-
description: '
|
|
4032
|
-
example: '30000.00'
|
|
4317
|
+
description: 'Matched transaction ID'
|
|
4033
4318
|
},
|
|
4034
|
-
|
|
4319
|
+
matchedAt: {
|
|
4035
4320
|
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
|
-
}
|
|
4321
|
+
description: 'Match timestamp (ISO 8601)'
|
|
4059
4322
|
},
|
|
4060
|
-
|
|
4061
|
-
|
|
4323
|
+
matchConfidence: {
|
|
4324
|
+
type: 'number',
|
|
4325
|
+
description: 'Match confidence score (0-1)'
|
|
4326
|
+
},
|
|
4327
|
+
isOverdue: {
|
|
4328
|
+
type: 'boolean',
|
|
4329
|
+
description: 'Whether this expected transaction is overdue'
|
|
4330
|
+
},
|
|
4331
|
+
rule: {
|
|
4332
|
+
description: 'Rule information',
|
|
4062
4333
|
allOf: [
|
|
4063
4334
|
{
|
|
4064
|
-
$ref: '#/components/schemas/
|
|
4335
|
+
$ref: '#/components/schemas/ExpectedTransactionRuleDto'
|
|
4065
4336
|
}
|
|
4066
4337
|
]
|
|
4067
4338
|
},
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
description: 'Period requested',
|
|
4071
|
-
example: '6m'
|
|
4072
|
-
},
|
|
4073
|
-
granularity: {
|
|
4339
|
+
createdAt: {
|
|
4340
|
+
format: 'date-time',
|
|
4074
4341
|
type: 'string',
|
|
4075
|
-
description: '
|
|
4076
|
-
example: 'month'
|
|
4342
|
+
description: 'Created at timestamp'
|
|
4077
4343
|
},
|
|
4078
|
-
|
|
4344
|
+
updatedAt: {
|
|
4345
|
+
format: 'date-time',
|
|
4079
4346
|
type: 'string',
|
|
4080
|
-
description: '
|
|
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
|
-
}
|
|
4347
|
+
description: 'Updated at timestamp'
|
|
4089
4348
|
}
|
|
4090
4349
|
},
|
|
4091
|
-
required: [
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
|
|
4095
|
-
|
|
4096
|
-
|
|
4097
|
-
|
|
4098
|
-
|
|
4099
|
-
|
|
4100
|
-
|
|
4101
|
-
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
export const $BackfillSnapshotsBody = {
|
|
4105
|
-
type: 'object',
|
|
4106
|
-
properties: {}
|
|
4107
|
-
} as const;
|
|
4108
|
-
|
|
4109
|
-
export const $BackfillSnapshotsResponse = {
|
|
4110
|
-
type: 'object',
|
|
4111
|
-
properties: {}
|
|
4350
|
+
required: [
|
|
4351
|
+
'id',
|
|
4352
|
+
'userId',
|
|
4353
|
+
'ruleId',
|
|
4354
|
+
'expectedDate',
|
|
4355
|
+
'expectedAmount',
|
|
4356
|
+
'status',
|
|
4357
|
+
'isOverdue',
|
|
4358
|
+
'rule',
|
|
4359
|
+
'createdAt',
|
|
4360
|
+
'updatedAt'
|
|
4361
|
+
]
|
|
4112
4362
|
} as const;
|
|
4113
4363
|
|
|
4114
|
-
export const $
|
|
4364
|
+
export const $ExpectedTransactionListResponseDto = {
|
|
4115
4365
|
type: 'object',
|
|
4116
4366
|
properties: {
|
|
4117
|
-
|
|
4118
|
-
type: '
|
|
4119
|
-
|
|
4120
|
-
|
|
4367
|
+
items: {
|
|
4368
|
+
type: 'array',
|
|
4369
|
+
items: {
|
|
4370
|
+
$ref: '#/components/schemas/ExpectedTransactionResponseDto'
|
|
4371
|
+
}
|
|
4372
|
+
},
|
|
4373
|
+
total: {
|
|
4374
|
+
type: 'number',
|
|
4375
|
+
description: 'Total count'
|
|
4121
4376
|
}
|
|
4122
4377
|
},
|
|
4123
|
-
required: ['
|
|
4378
|
+
required: ['items', 'total']
|
|
4124
4379
|
} as const;
|
|
4125
4380
|
|
|
4126
|
-
export const $
|
|
4381
|
+
export const $ConfirmMatchDto = {
|
|
4127
4382
|
type: 'object',
|
|
4128
4383
|
properties: {
|
|
4129
|
-
|
|
4384
|
+
transactionId: {
|
|
4130
4385
|
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
|
|
4386
|
+
description: 'Transaction ID to match with'
|
|
4135
4387
|
}
|
|
4136
4388
|
},
|
|
4137
|
-
required: ['
|
|
4389
|
+
required: ['transactionId']
|
|
4138
4390
|
} as const;
|
|
4139
4391
|
|
|
4140
|
-
export const $
|
|
4392
|
+
export const $EnterNowDto = {
|
|
4141
4393
|
type: 'object',
|
|
4142
4394
|
properties: {
|
|
4143
|
-
|
|
4395
|
+
expenseAccount: {
|
|
4144
4396
|
type: 'string',
|
|
4145
|
-
description:
|
|
4397
|
+
description:
|
|
4398
|
+
'Override expense account (uses rule default if not provided)',
|
|
4399
|
+
maxLength: 200
|
|
4146
4400
|
},
|
|
4147
|
-
|
|
4401
|
+
paymentAccount: {
|
|
4148
4402
|
type: 'string',
|
|
4149
|
-
description:
|
|
4403
|
+
description:
|
|
4404
|
+
'Override payment account (uses rule default if not provided)',
|
|
4405
|
+
maxLength: 200
|
|
4150
4406
|
},
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
|
|
4154
|
-
|
|
4155
|
-
type: 'string'
|
|
4156
|
-
}
|
|
4407
|
+
amount: {
|
|
4408
|
+
type: 'number',
|
|
4409
|
+
description: 'Override amount (uses expected amount if not provided)',
|
|
4410
|
+
minimum: 0
|
|
4157
4411
|
},
|
|
4158
|
-
|
|
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: {
|
|
4412
|
+
payee: {
|
|
4174
4413
|
type: 'string',
|
|
4175
|
-
description:
|
|
4176
|
-
|
|
4177
|
-
|
|
4414
|
+
description: 'Override payee (uses rule default if not provided)',
|
|
4415
|
+
maxLength: 200
|
|
4416
|
+
},
|
|
4417
|
+
narration: {
|
|
4418
|
+
type: 'string',
|
|
4419
|
+
description: 'Optional narration',
|
|
4420
|
+
maxLength: 500
|
|
4178
4421
|
}
|
|
4179
4422
|
}
|
|
4180
4423
|
} as const;
|
|
4181
4424
|
|
|
4182
|
-
export const $
|
|
4425
|
+
export const $ForecastItemDto = {
|
|
4183
4426
|
type: 'object',
|
|
4184
4427
|
properties: {
|
|
4185
|
-
|
|
4186
|
-
type: 'string',
|
|
4187
|
-
description: 'JWT auth token',
|
|
4188
|
-
example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
|
|
4189
|
-
},
|
|
4190
|
-
accessToken: {
|
|
4428
|
+
rule: {
|
|
4191
4429
|
type: 'string',
|
|
4192
|
-
description: '
|
|
4430
|
+
description: 'Rule name',
|
|
4431
|
+
example: 'Rent'
|
|
4193
4432
|
},
|
|
4194
|
-
|
|
4433
|
+
ruleId: {
|
|
4195
4434
|
type: 'string',
|
|
4196
|
-
description: '
|
|
4197
|
-
|
|
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'
|
|
4435
|
+
description: 'Rule ID',
|
|
4436
|
+
example: 'clx123...'
|
|
4209
4437
|
},
|
|
4210
|
-
|
|
4438
|
+
amount: {
|
|
4211
4439
|
type: 'number',
|
|
4212
|
-
description: '
|
|
4213
|
-
example:
|
|
4214
|
-
},
|
|
4215
|
-
currency: {
|
|
4216
|
-
type: 'string',
|
|
4217
|
-
description: 'Currency code',
|
|
4218
|
-
example: 'USD'
|
|
4440
|
+
description: 'Expected amount',
|
|
4441
|
+
example: 3000
|
|
4219
4442
|
},
|
|
4220
|
-
|
|
4443
|
+
date: {
|
|
4221
4444
|
type: 'string',
|
|
4222
|
-
description: '
|
|
4223
|
-
example: '
|
|
4445
|
+
description: 'Expected date (YYYY-MM-DD)',
|
|
4446
|
+
example: '2024-04-01'
|
|
4224
4447
|
},
|
|
4225
|
-
|
|
4448
|
+
icon: {
|
|
4226
4449
|
type: 'string',
|
|
4227
|
-
description: '
|
|
4228
|
-
example: '
|
|
4450
|
+
description: 'Rule icon emoji',
|
|
4451
|
+
example: '🏠',
|
|
4452
|
+
nullable: true
|
|
4229
4453
|
},
|
|
4230
|
-
|
|
4454
|
+
currency: {
|
|
4231
4455
|
type: 'string',
|
|
4232
|
-
description: '
|
|
4233
|
-
|
|
4234
|
-
}
|
|
4235
|
-
|
|
4456
|
+
description: 'Currency code',
|
|
4457
|
+
example: 'CNY'
|
|
4458
|
+
}
|
|
4459
|
+
},
|
|
4460
|
+
required: ['rule', 'ruleId', 'amount', 'date', 'icon', 'currency']
|
|
4461
|
+
} as const;
|
|
4462
|
+
|
|
4463
|
+
export const $MonthlyForecastDto = {
|
|
4464
|
+
type: 'object',
|
|
4465
|
+
properties: {
|
|
4466
|
+
month: {
|
|
4236
4467
|
type: 'string',
|
|
4237
|
-
description: '
|
|
4238
|
-
example: '
|
|
4468
|
+
description: 'Month (YYYY-MM)',
|
|
4469
|
+
example: '2024-04'
|
|
4239
4470
|
},
|
|
4240
|
-
|
|
4471
|
+
expectedOutflow: {
|
|
4241
4472
|
type: 'number',
|
|
4242
|
-
description: '
|
|
4243
|
-
example:
|
|
4473
|
+
description: 'Total expected outflow for the month',
|
|
4474
|
+
example: 8500
|
|
4244
4475
|
},
|
|
4245
|
-
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
4476
|
+
itemCount: {
|
|
4477
|
+
type: 'number',
|
|
4478
|
+
description: 'Number of expected transactions',
|
|
4479
|
+
example: 3
|
|
4480
|
+
},
|
|
4481
|
+
byCurrency: {
|
|
4482
|
+
type: 'object',
|
|
4483
|
+
description: 'Breakdown by currency',
|
|
4484
|
+
example: {
|
|
4485
|
+
CNY: 8500,
|
|
4486
|
+
USD: 100
|
|
4250
4487
|
}
|
|
4251
4488
|
},
|
|
4252
|
-
|
|
4253
|
-
description: '
|
|
4489
|
+
items: {
|
|
4490
|
+
description: 'Individual forecast items',
|
|
4254
4491
|
type: 'array',
|
|
4255
4492
|
items: {
|
|
4256
|
-
|
|
4493
|
+
$ref: '#/components/schemas/ForecastItemDto'
|
|
4257
4494
|
}
|
|
4258
|
-
}
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
|
-
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
|
|
4266
|
-
|
|
4267
|
-
|
|
4268
|
-
description: 'Tag filters',
|
|
4495
|
+
}
|
|
4496
|
+
},
|
|
4497
|
+
required: ['month', 'expectedOutflow', 'itemCount', 'byCurrency', 'items']
|
|
4498
|
+
} as const;
|
|
4499
|
+
|
|
4500
|
+
export const $ForecastResponseDto = {
|
|
4501
|
+
type: 'object',
|
|
4502
|
+
properties: {
|
|
4503
|
+
forecast: {
|
|
4504
|
+
description: 'Monthly forecast data',
|
|
4269
4505
|
type: 'array',
|
|
4270
4506
|
items: {
|
|
4271
|
-
|
|
4507
|
+
$ref: '#/components/schemas/MonthlyForecastDto'
|
|
4272
4508
|
}
|
|
4273
4509
|
},
|
|
4274
|
-
|
|
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: {
|
|
4510
|
+
totalOutflow: {
|
|
4293
4511
|
type: 'number',
|
|
4294
|
-
description: '
|
|
4295
|
-
example:
|
|
4512
|
+
description: 'Total expected outflow across all months',
|
|
4513
|
+
example: 25500
|
|
4296
4514
|
},
|
|
4297
|
-
|
|
4298
|
-
type: '
|
|
4299
|
-
description: '
|
|
4300
|
-
example:
|
|
4515
|
+
totalByCurrency: {
|
|
4516
|
+
type: 'object',
|
|
4517
|
+
description: 'Total by currency across all months',
|
|
4518
|
+
example: {
|
|
4519
|
+
CNY: 25500,
|
|
4520
|
+
USD: 300
|
|
4521
|
+
}
|
|
4301
4522
|
},
|
|
4302
|
-
|
|
4523
|
+
rulesCount: {
|
|
4303
4524
|
type: 'number',
|
|
4304
|
-
description: '
|
|
4305
|
-
example:
|
|
4525
|
+
description: 'Number of active recurring rules included',
|
|
4526
|
+
example: 5
|
|
4306
4527
|
},
|
|
4307
|
-
|
|
4528
|
+
periodStart: {
|
|
4308
4529
|
type: 'string',
|
|
4309
|
-
description: '
|
|
4310
|
-
|
|
4311
|
-
}
|
|
4312
|
-
|
|
4313
|
-
} as const;
|
|
4314
|
-
|
|
4315
|
-
export const $UpdatePropertyDto = {
|
|
4316
|
-
type: 'object',
|
|
4317
|
-
properties: {
|
|
4318
|
-
value: {
|
|
4530
|
+
description: 'Forecast period start date',
|
|
4531
|
+
example: '2024-04-01'
|
|
4532
|
+
},
|
|
4533
|
+
periodEnd: {
|
|
4319
4534
|
type: 'string',
|
|
4320
|
-
description: '
|
|
4535
|
+
description: 'Forecast period end date',
|
|
4536
|
+
example: '2024-06-30'
|
|
4321
4537
|
}
|
|
4322
4538
|
},
|
|
4323
|
-
required: [
|
|
4539
|
+
required: [
|
|
4540
|
+
'forecast',
|
|
4541
|
+
'totalOutflow',
|
|
4542
|
+
'totalByCurrency',
|
|
4543
|
+
'rulesCount',
|
|
4544
|
+
'periodStart',
|
|
4545
|
+
'periodEnd'
|
|
4546
|
+
]
|
|
4324
4547
|
} as const;
|
|
4325
4548
|
|
|
4326
4549
|
export const $CreateTransactionRuleDto = {
|
|
@@ -4882,7 +5105,8 @@ export const $UpdateTransactionRuleDto = {
|
|
|
4882
5105
|
},
|
|
4883
5106
|
matchLogic: {
|
|
4884
5107
|
type: 'string',
|
|
4885
|
-
enum: ['OR', 'AND']
|
|
5108
|
+
enum: ['OR', 'AND'],
|
|
5109
|
+
default: 'OR'
|
|
4886
5110
|
},
|
|
4887
5111
|
amountMin: {
|
|
4888
5112
|
type: 'number',
|
|
@@ -4896,13 +5120,10 @@ export const $UpdateTransactionRuleDto = {
|
|
|
4896
5120
|
},
|
|
4897
5121
|
priority: {
|
|
4898
5122
|
type: 'number',
|
|
5123
|
+
default: 50,
|
|
4899
5124
|
minimum: 0,
|
|
4900
5125
|
maximum: 1000
|
|
4901
5126
|
},
|
|
4902
|
-
enabled: {
|
|
4903
|
-
type: 'boolean',
|
|
4904
|
-
description: 'Enable or disable the rule'
|
|
4905
|
-
},
|
|
4906
5127
|
additionalTags: {
|
|
4907
5128
|
items: {
|
|
4908
5129
|
type: 'array'
|
|
@@ -4912,6 +5133,10 @@ export const $UpdateTransactionRuleDto = {
|
|
|
4912
5133
|
},
|
|
4913
5134
|
additionalMetadata: {
|
|
4914
5135
|
type: 'object'
|
|
5136
|
+
},
|
|
5137
|
+
enabled: {
|
|
5138
|
+
type: 'boolean',
|
|
5139
|
+
description: 'Enable or disable the rule'
|
|
4915
5140
|
}
|
|
4916
5141
|
}
|
|
4917
5142
|
} as const;
|
|
@@ -5005,9 +5230,23 @@ export const $CategoryCatalogEntryDto = {
|
|
|
5005
5230
|
items: {
|
|
5006
5231
|
type: 'string'
|
|
5007
5232
|
}
|
|
5233
|
+
},
|
|
5234
|
+
categoryAccounts: {
|
|
5235
|
+
description:
|
|
5236
|
+
"Beancount account paths (categoryAccount) of the region-enabled system rules whose categoryKeywords include this slug (#816). System rules only (public endpoint — user rules excluded); one-to-many by design (e.g. 'utilities' → Electricity/Water/Internet/Gas), sorted, [] when no rule maps the slug.",
|
|
5237
|
+
example: [
|
|
5238
|
+
'Expenses:Utilities:Electricity',
|
|
5239
|
+
'Expenses:Utilities:Gas',
|
|
5240
|
+
'Expenses:Utilities:Internet',
|
|
5241
|
+
'Expenses:Utilities:Water'
|
|
5242
|
+
],
|
|
5243
|
+
type: 'array',
|
|
5244
|
+
items: {
|
|
5245
|
+
type: 'string'
|
|
5246
|
+
}
|
|
5008
5247
|
}
|
|
5009
5248
|
},
|
|
5010
|
-
required: ['slug', 'scenario', 'icon', 'regions']
|
|
5249
|
+
required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
|
|
5011
5250
|
} as const;
|
|
5012
5251
|
|
|
5013
5252
|
export const $CategoryCatalogListResponseDto = {
|
|
@@ -5198,6 +5437,14 @@ export const $OnboardingAccountDto = {
|
|
|
5198
5437
|
description:
|
|
5199
5438
|
'Platform ID to bind the account to (references Platform.id); omit for unbound',
|
|
5200
5439
|
example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
|
|
5440
|
+
},
|
|
5441
|
+
displayName: {
|
|
5442
|
+
type: 'string',
|
|
5443
|
+
description:
|
|
5444
|
+
'User-set display name override (omit/null = keep the derived name)',
|
|
5445
|
+
nullable: true,
|
|
5446
|
+
maxLength: 50,
|
|
5447
|
+
example: 'Salary card'
|
|
5201
5448
|
}
|
|
5202
5449
|
},
|
|
5203
5450
|
required: ['path', 'currency']
|
|
@@ -6118,8 +6365,9 @@ export const $ClientParsedDataDto = {
|
|
|
6118
6365
|
},
|
|
6119
6366
|
category: {
|
|
6120
6367
|
type: 'string',
|
|
6121
|
-
description:
|
|
6122
|
-
|
|
6368
|
+
description:
|
|
6369
|
+
'Category in canonical form (catalog slug or Stage-2 rule keyword token, ADR-0116) — echo back verbatim from parsedData.category. Foreign forms (locale display names, account paths) are rejected with nlp.category.invalid.',
|
|
6370
|
+
example: 'food'
|
|
6123
6371
|
},
|
|
6124
6372
|
incomeType: {
|
|
6125
6373
|
type: 'string',
|
|
@@ -6217,8 +6465,27 @@ export const $ProcessNlpDto = {
|
|
|
6217
6465
|
selectedAccount: {
|
|
6218
6466
|
type: 'string',
|
|
6219
6467
|
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.',
|
|
6468
|
+
'confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i].path, or a typed path). Applied directly when the session is confirming_account — no NL re-parse.',
|
|
6221
6469
|
example: 'Expenses:Food:Coffee'
|
|
6470
|
+
},
|
|
6471
|
+
viewpointAccount: {
|
|
6472
|
+
type: 'string',
|
|
6473
|
+
description:
|
|
6474
|
+
'Viewpoint account hint: the beancount path the user drilled into (e.g. from an account drill-down). Tie-break only — never overrides accounts resolved from the text. Must be an owned, OPEN Assets:/Liabilities: account; unresolvable hints are silently ignored.',
|
|
6475
|
+
example: 'Assets:CN:Bank:ICBC'
|
|
6476
|
+
},
|
|
6477
|
+
viewpointCategory: {
|
|
6478
|
+
type: 'string',
|
|
6479
|
+
description:
|
|
6480
|
+
"Viewpoint category hint: the ADR-0075 Group segment the user drilled into (e.g. 'Food'). Resolved to a concrete OPEN account in that group; tie-break only — never overrides a category resolved from the text.",
|
|
6481
|
+
example: 'Food'
|
|
6482
|
+
},
|
|
6483
|
+
viewpointFlow: {
|
|
6484
|
+
type: 'string',
|
|
6485
|
+
description:
|
|
6486
|
+
"Companion flow root for viewpointCategory ('income' | 'expense'), mirroring the ADR-0126 list-endpoint invariant. Derived from the session's routed intent (multi-turn) when absent; a first-turn flow-less category hint is dropped — send the flow explicitly.",
|
|
6487
|
+
enum: ['income', 'expense'],
|
|
6488
|
+
example: 'expense'
|
|
6222
6489
|
}
|
|
6223
6490
|
}
|
|
6224
6491
|
} as const;
|
|
@@ -6286,7 +6553,9 @@ export const $NlpParsedDataDto = {
|
|
|
6286
6553
|
},
|
|
6287
6554
|
category: {
|
|
6288
6555
|
type: 'string',
|
|
6289
|
-
description:
|
|
6556
|
+
description:
|
|
6557
|
+
'Category in canonical form: a CATEGORY_CATALOG slug (GET /{region}/bean/categories) or a Stage-2 rule categoryKeywords token (ADR-0116 D2). Never a locale display name or a beancount account path. Echo back verbatim on confirm.',
|
|
6558
|
+
example: 'food'
|
|
6290
6559
|
},
|
|
6291
6560
|
incomeType: {
|
|
6292
6561
|
type: 'string',
|
|
@@ -6532,6 +6801,24 @@ export const $NlpRuleConfirmationDataDto = {
|
|
|
6532
6801
|
]
|
|
6533
6802
|
} as const;
|
|
6534
6803
|
|
|
6804
|
+
export const $NlpAccountCandidateDto = {
|
|
6805
|
+
type: 'object',
|
|
6806
|
+
properties: {
|
|
6807
|
+
path: {
|
|
6808
|
+
type: 'string',
|
|
6809
|
+
description: 'Canonical beancount account path (echo back on selection)',
|
|
6810
|
+
example: 'Expenses:Food:Dining'
|
|
6811
|
+
},
|
|
6812
|
+
name: {
|
|
6813
|
+
type: 'string',
|
|
6814
|
+
description:
|
|
6815
|
+
'Localized display name (ADR-0114 read-time projection, user locale)',
|
|
6816
|
+
example: '餐饮'
|
|
6817
|
+
}
|
|
6818
|
+
},
|
|
6819
|
+
required: ['path', 'name']
|
|
6820
|
+
} as const;
|
|
6821
|
+
|
|
6535
6822
|
export const $NlpAccountConfirmationDataDto = {
|
|
6536
6823
|
type: 'object',
|
|
6537
6824
|
properties: {
|
|
@@ -6547,10 +6834,11 @@ export const $NlpAccountConfirmationDataDto = {
|
|
|
6547
6834
|
example: 'Expenses:Food:Drinks'
|
|
6548
6835
|
},
|
|
6549
6836
|
similarAccounts: {
|
|
6550
|
-
description:
|
|
6837
|
+
description:
|
|
6838
|
+
'Similar accounts for user selection (path + localized name, #680)',
|
|
6551
6839
|
type: 'array',
|
|
6552
6840
|
items: {
|
|
6553
|
-
|
|
6841
|
+
$ref: '#/components/schemas/NlpAccountCandidateDto'
|
|
6554
6842
|
}
|
|
6555
6843
|
},
|
|
6556
6844
|
errorMessage: {
|
|
@@ -6838,7 +7126,7 @@ export const $NlpResponseDto = {
|
|
|
6838
7126
|
type: 'string',
|
|
6839
7127
|
description:
|
|
6840
7128
|
'Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.',
|
|
6841
|
-
enum: ['transfer', 'banking', 'investment'],
|
|
7129
|
+
enum: ['transfer', 'banking', 'investment', 'lend', 'lend_collect'],
|
|
6842
7130
|
example: 'investment'
|
|
6843
7131
|
},
|
|
6844
7132
|
liabilitySubType: {
|
|
@@ -7127,55 +7415,128 @@ export const $PlatformMatchResultDto = {
|
|
|
7127
7415
|
category: {
|
|
7128
7416
|
type: 'string',
|
|
7129
7417
|
description:
|
|
7130
|
-
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
|
|
7418
|
+
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
|
|
7419
|
+
nullable: true,
|
|
7420
|
+
example: 'DigitalWallet'
|
|
7421
|
+
},
|
|
7422
|
+
matchType: {
|
|
7423
|
+
type: 'string',
|
|
7424
|
+
description: "How this row matched: 'exact' > 'prefix' > 'substring'",
|
|
7425
|
+
enum: ['exact', 'prefix', 'substring']
|
|
7426
|
+
}
|
|
7427
|
+
},
|
|
7428
|
+
required: [
|
|
7429
|
+
'id',
|
|
7430
|
+
'name',
|
|
7431
|
+
'canonical',
|
|
7432
|
+
'type',
|
|
7433
|
+
'suggestedSegment',
|
|
7434
|
+
'logoUrl',
|
|
7435
|
+
'countryCode',
|
|
7436
|
+
'category',
|
|
7437
|
+
'matchType'
|
|
7438
|
+
]
|
|
7439
|
+
} as const;
|
|
7440
|
+
|
|
7441
|
+
export const $PlatformMatchResponseDto = {
|
|
7442
|
+
type: 'object',
|
|
7443
|
+
properties: {
|
|
7444
|
+
platforms: {
|
|
7445
|
+
description: 'Ranked matches, best tier first (at most 10 rows)',
|
|
7446
|
+
type: 'array',
|
|
7447
|
+
items: {
|
|
7448
|
+
$ref: '#/components/schemas/PlatformMatchResultDto'
|
|
7449
|
+
}
|
|
7450
|
+
},
|
|
7451
|
+
matchType: {
|
|
7452
|
+
type: 'string',
|
|
7453
|
+
description:
|
|
7454
|
+
"Overall match quality — top row's tier, or 'none' when no hits",
|
|
7455
|
+
enum: ['none', 'exact', 'prefix', 'substring']
|
|
7456
|
+
},
|
|
7457
|
+
total: {
|
|
7458
|
+
type: 'number',
|
|
7459
|
+
description: 'Total matches before LIMIT (truncation transparency)'
|
|
7460
|
+
},
|
|
7461
|
+
hasMore: {
|
|
7462
|
+
type: 'boolean',
|
|
7463
|
+
description: 'true when total > platforms.length (more matches exist)'
|
|
7464
|
+
}
|
|
7465
|
+
},
|
|
7466
|
+
required: ['platforms', 'matchType', 'total', 'hasMore']
|
|
7467
|
+
} as const;
|
|
7468
|
+
|
|
7469
|
+
export const $PlatformStandardsPlatformDto = {
|
|
7470
|
+
type: 'object',
|
|
7471
|
+
properties: {
|
|
7472
|
+
id: {
|
|
7473
|
+
type: 'string',
|
|
7474
|
+
description: 'Global platform ID'
|
|
7475
|
+
},
|
|
7476
|
+
name: {
|
|
7477
|
+
type: 'string',
|
|
7478
|
+
description: 'Platform name (e.g., "ICBC")'
|
|
7479
|
+
},
|
|
7480
|
+
canonical: {
|
|
7481
|
+
type: 'string',
|
|
7482
|
+
description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
|
|
7483
|
+
},
|
|
7484
|
+
suggestedSegment: {
|
|
7485
|
+
type: 'string',
|
|
7486
|
+
description:
|
|
7487
|
+
'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
|
|
7488
|
+
},
|
|
7489
|
+
type: {
|
|
7490
|
+
type: 'string',
|
|
7491
|
+
description: 'Platform type',
|
|
7492
|
+
enum: [
|
|
7493
|
+
'BANK',
|
|
7494
|
+
'BROKERAGE',
|
|
7495
|
+
'CRYPTO_EXCHANGE',
|
|
7496
|
+
'PAYMENT',
|
|
7497
|
+
'INVESTMENT',
|
|
7498
|
+
'INSURANCE',
|
|
7499
|
+
'OTHER'
|
|
7500
|
+
]
|
|
7501
|
+
},
|
|
7502
|
+
category: {
|
|
7503
|
+
type: 'string',
|
|
7504
|
+
description:
|
|
7505
|
+
'Region-aware category (institution vocab, e.g. DigitalWallet/Bank) resolved against the final region. null = no region-aware suggestion; fall back to type.',
|
|
7131
7506
|
nullable: true,
|
|
7132
|
-
example: '
|
|
7133
|
-
},
|
|
7134
|
-
matchType: {
|
|
7135
|
-
type: 'string',
|
|
7136
|
-
description: "How this row matched: 'exact' > 'prefix' > 'substring'",
|
|
7137
|
-
enum: ['exact', 'prefix', 'substring']
|
|
7507
|
+
example: 'Bank'
|
|
7138
7508
|
}
|
|
7139
7509
|
},
|
|
7140
|
-
required: [
|
|
7141
|
-
'id',
|
|
7142
|
-
'name',
|
|
7143
|
-
'canonical',
|
|
7144
|
-
'type',
|
|
7145
|
-
'suggestedSegment',
|
|
7146
|
-
'logoUrl',
|
|
7147
|
-
'countryCode',
|
|
7148
|
-
'category',
|
|
7149
|
-
'matchType'
|
|
7150
|
-
]
|
|
7510
|
+
required: ['id', 'name', 'canonical', 'suggestedSegment', 'type', 'category']
|
|
7151
7511
|
} as const;
|
|
7152
7512
|
|
|
7153
|
-
export const $
|
|
7513
|
+
export const $PlatformStandardsResponseDto = {
|
|
7154
7514
|
type: 'object',
|
|
7155
7515
|
properties: {
|
|
7156
|
-
|
|
7157
|
-
description: '
|
|
7158
|
-
|
|
7159
|
-
|
|
7160
|
-
|
|
7161
|
-
|
|
7516
|
+
platform: {
|
|
7517
|
+
description: 'The selected platform (institution lock source)',
|
|
7518
|
+
allOf: [
|
|
7519
|
+
{
|
|
7520
|
+
$ref: '#/components/schemas/PlatformStandardsPlatformDto'
|
|
7521
|
+
}
|
|
7522
|
+
]
|
|
7162
7523
|
},
|
|
7163
|
-
|
|
7524
|
+
region: {
|
|
7164
7525
|
type: 'string',
|
|
7165
7526
|
description:
|
|
7166
|
-
"
|
|
7167
|
-
|
|
7168
|
-
},
|
|
7169
|
-
total: {
|
|
7170
|
-
type: 'number',
|
|
7171
|
-
description: 'Total matches before LIMIT (truncation transparency)'
|
|
7527
|
+
"Resolved template region (ISO 3166-1 alpha-2, UPPERCASE): the platform's own countryCode when set, else the region query param. For regions without a regional template file the template list falls back to the universal-only catalog while region still echoes the code.",
|
|
7528
|
+
example: 'CN'
|
|
7172
7529
|
},
|
|
7173
|
-
|
|
7174
|
-
|
|
7175
|
-
|
|
7530
|
+
templates: {
|
|
7531
|
+
description:
|
|
7532
|
+
'Candidate account-standard templates of the resolved region (groupable by productCategory client-side)',
|
|
7533
|
+
type: 'array',
|
|
7534
|
+
items: {
|
|
7535
|
+
$ref: '#/components/schemas/AccountStandardResponseDto'
|
|
7536
|
+
}
|
|
7176
7537
|
}
|
|
7177
7538
|
},
|
|
7178
|
-
required: ['
|
|
7539
|
+
required: ['platform', 'region', 'templates']
|
|
7179
7540
|
} as const;
|
|
7180
7541
|
|
|
7181
7542
|
export const $CreatePlatformDto = {
|
|
@@ -7279,7 +7640,8 @@ export const $UpdatePlatformDto = {
|
|
|
7279
7640
|
},
|
|
7280
7641
|
isActive: {
|
|
7281
7642
|
type: 'boolean',
|
|
7282
|
-
description: 'Whether the platform is active'
|
|
7643
|
+
description: 'Whether the platform is active',
|
|
7644
|
+
default: true
|
|
7283
7645
|
}
|
|
7284
7646
|
}
|
|
7285
7647
|
} as const;
|
|
@@ -7442,7 +7804,8 @@ export const $AccountItemDto = {
|
|
|
7442
7804
|
},
|
|
7443
7805
|
displayName: {
|
|
7444
7806
|
type: 'string',
|
|
7445
|
-
description:
|
|
7807
|
+
description:
|
|
7808
|
+
'Display name: user-set name if provided (#762), else the ADR-0114 chain — request-locale catalog name, en pivot, then the last part of the account path (#771)',
|
|
7446
7809
|
example: 'Savings'
|
|
7447
7810
|
},
|
|
7448
7811
|
balance: {
|
|
@@ -7478,7 +7841,8 @@ export const $PlatformGroupDto = {
|
|
|
7478
7841
|
example: 'CMB Bank'
|
|
7479
7842
|
},
|
|
7480
7843
|
accounts: {
|
|
7481
|
-
description:
|
|
7844
|
+
description:
|
|
7845
|
+
'Accounts within this platform (Assets and Liabilities rows, #696)',
|
|
7482
7846
|
type: 'array',
|
|
7483
7847
|
items: {
|
|
7484
7848
|
$ref: '#/components/schemas/AccountItemDto'
|
|
@@ -7486,7 +7850,8 @@ export const $PlatformGroupDto = {
|
|
|
7486
7850
|
},
|
|
7487
7851
|
totalBalance: {
|
|
7488
7852
|
type: 'string',
|
|
7489
|
-
description:
|
|
7853
|
+
description:
|
|
7854
|
+
'FX-converted total balance in base currency (nets Assets + Liabilities rows; can be negative)',
|
|
7490
7855
|
example: '100000.00'
|
|
7491
7856
|
},
|
|
7492
7857
|
balanceByCurrency: {
|
|
@@ -7505,7 +7870,7 @@ export const $PlatformGroupDto = {
|
|
|
7505
7870
|
sharePct: {
|
|
7506
7871
|
type: 'number',
|
|
7507
7872
|
description:
|
|
7508
|
-
'Share of the grand
|
|
7873
|
+
'Share of the converted asset-side grand total (0-100); liability balances are excluded from the basis; 0 when grand total is 0 (#696)',
|
|
7509
7874
|
example: 42.5
|
|
7510
7875
|
}
|
|
7511
7876
|
},
|
|
@@ -7553,7 +7918,8 @@ export const $AccountsSummaryDto = {
|
|
|
7553
7918
|
properties: {
|
|
7554
7919
|
totalAccounts: {
|
|
7555
7920
|
type: 'number',
|
|
7556
|
-
description:
|
|
7921
|
+
description:
|
|
7922
|
+
'Total number of accounts (balance sheet: Assets + Liabilities, #696)'
|
|
7557
7923
|
},
|
|
7558
7924
|
totalPlatforms: {
|
|
7559
7925
|
type: 'number',
|
|
@@ -7611,7 +7977,8 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
7611
7977
|
},
|
|
7612
7978
|
displayName: {
|
|
7613
7979
|
type: 'string',
|
|
7614
|
-
description:
|
|
7980
|
+
description:
|
|
7981
|
+
'Display name: user-set name if provided (#762), else the ADR-0114 chain — request-locale catalog name, en pivot, then the last part of the account path (#771)',
|
|
7615
7982
|
example: 'Savings'
|
|
7616
7983
|
},
|
|
7617
7984
|
balance: {
|
|
@@ -8097,7 +8464,7 @@ export const $MonetaryDto = {
|
|
|
8097
8464
|
example: 'USD'
|
|
8098
8465
|
},
|
|
8099
8466
|
baseCcyEquivalent: {
|
|
8100
|
-
type: '
|
|
8467
|
+
type: 'string',
|
|
8101
8468
|
description: 'Converted to user base currency (Decimal string)',
|
|
8102
8469
|
example: '21600',
|
|
8103
8470
|
nullable: true
|
|
@@ -8173,13 +8540,13 @@ export const $HoldingPnlRowDto = {
|
|
|
8173
8540
|
example: 'Assets:US:Broker:AAPL'
|
|
8174
8541
|
},
|
|
8175
8542
|
accountCcy: {
|
|
8176
|
-
type: '
|
|
8543
|
+
type: 'string',
|
|
8177
8544
|
description: 'Account settlement currency (ISO 4217), from cost currency',
|
|
8178
8545
|
nullable: true,
|
|
8179
8546
|
example: 'USD'
|
|
8180
8547
|
},
|
|
8181
8548
|
brokerType: {
|
|
8182
|
-
type: '
|
|
8549
|
+
type: 'string',
|
|
8183
8550
|
description: 'Broker type derived from Platform.type',
|
|
8184
8551
|
nullable: true,
|
|
8185
8552
|
example: 'broker'
|
|
@@ -8200,7 +8567,7 @@ export const $HoldingPnlRowDto = {
|
|
|
8200
8567
|
example: 'EQUITY'
|
|
8201
8568
|
},
|
|
8202
8569
|
assetSubClass: {
|
|
8203
|
-
type: '
|
|
8570
|
+
type: 'string',
|
|
8204
8571
|
nullable: true,
|
|
8205
8572
|
example: 'STOCK'
|
|
8206
8573
|
},
|
|
@@ -8247,14 +8614,14 @@ export const $HoldingPnlRowDto = {
|
|
|
8247
8614
|
]
|
|
8248
8615
|
},
|
|
8249
8616
|
unrealizedPnlBase: {
|
|
8250
|
-
type: '
|
|
8617
|
+
type: 'string',
|
|
8251
8618
|
description:
|
|
8252
8619
|
'Unrealized P&L in base currency (Decimal string); null when any FX/price missing',
|
|
8253
8620
|
nullable: true,
|
|
8254
8621
|
example: '6000'
|
|
8255
8622
|
},
|
|
8256
8623
|
unrealizedPnlPct: {
|
|
8257
|
-
type: '
|
|
8624
|
+
type: 'string',
|
|
8258
8625
|
description: 'Unrealized P&L % (Decimal string)',
|
|
8259
8626
|
nullable: true,
|
|
8260
8627
|
example: '25'
|
|
@@ -8278,7 +8645,7 @@ export const $HoldingPnlRowDto = {
|
|
|
8278
8645
|
]
|
|
8279
8646
|
},
|
|
8280
8647
|
pctOfInvestedAssets: {
|
|
8281
|
-
type: '
|
|
8648
|
+
type: 'string',
|
|
8282
8649
|
description:
|
|
8283
8650
|
'Share of invested assets % (Decimal string); only for invested chartTokens',
|
|
8284
8651
|
nullable: true,
|
|
@@ -8323,15 +8690,15 @@ export const $HoldingPnlWarningDto = {
|
|
|
8323
8690
|
]
|
|
8324
8691
|
},
|
|
8325
8692
|
symbol: {
|
|
8326
|
-
type: '
|
|
8693
|
+
type: 'string',
|
|
8327
8694
|
nullable: true
|
|
8328
8695
|
},
|
|
8329
8696
|
accountId: {
|
|
8330
|
-
type: '
|
|
8697
|
+
type: 'string',
|
|
8331
8698
|
nullable: true
|
|
8332
8699
|
},
|
|
8333
8700
|
currency: {
|
|
8334
|
-
type: '
|
|
8701
|
+
type: 'string',
|
|
8335
8702
|
nullable: true
|
|
8336
8703
|
}
|
|
8337
8704
|
},
|
|
@@ -8395,6 +8762,216 @@ export const $AnonymousLoginResponseDto = {
|
|
|
8395
8762
|
required: ['authToken']
|
|
8396
8763
|
} as const;
|
|
8397
8764
|
|
|
8765
|
+
export const $ParserContributionMetaDto = {
|
|
8766
|
+
type: 'object',
|
|
8767
|
+
properties: {
|
|
8768
|
+
institution: {
|
|
8769
|
+
type: 'string',
|
|
8770
|
+
description: 'Institution slug (lowercase kebab-case)',
|
|
8771
|
+
pattern: '^[a-z0-9]+(-[a-z0-9]+)*$',
|
|
8772
|
+
example: 'icbc'
|
|
8773
|
+
},
|
|
8774
|
+
region: {
|
|
8775
|
+
type: 'string',
|
|
8776
|
+
enum: [
|
|
8777
|
+
'cn',
|
|
8778
|
+
'us',
|
|
8779
|
+
'de',
|
|
8780
|
+
'fr',
|
|
8781
|
+
'gb',
|
|
8782
|
+
'hk',
|
|
8783
|
+
'jp',
|
|
8784
|
+
'sg',
|
|
8785
|
+
'au',
|
|
8786
|
+
'ca',
|
|
8787
|
+
'other'
|
|
8788
|
+
]
|
|
8789
|
+
},
|
|
8790
|
+
accountType: {
|
|
8791
|
+
type: 'string',
|
|
8792
|
+
enum: ['checking', 'savings', 'credit', 'debit', 'investment']
|
|
8793
|
+
},
|
|
8794
|
+
format: {
|
|
8795
|
+
type: 'string',
|
|
8796
|
+
enum: ['csv', 'xlsx', 'pdf', 'ofx', 'qif']
|
|
8797
|
+
},
|
|
8798
|
+
institutionDisplayName: {
|
|
8799
|
+
type: 'string',
|
|
8800
|
+
example: '中国工商银行'
|
|
8801
|
+
},
|
|
8802
|
+
encoding: {
|
|
8803
|
+
type: 'string',
|
|
8804
|
+
example: 'utf-8'
|
|
8805
|
+
},
|
|
8806
|
+
delimiter: {
|
|
8807
|
+
type: 'string',
|
|
8808
|
+
description: 'CSV delimiter character: ",", ";", "\\t" or "|"'
|
|
8809
|
+
},
|
|
8810
|
+
headerRows: {
|
|
8811
|
+
type: 'number',
|
|
8812
|
+
default: 1,
|
|
8813
|
+
description: 'Header row count; the client omits the field when it is 1'
|
|
8814
|
+
},
|
|
8815
|
+
notes: {
|
|
8816
|
+
type: 'string',
|
|
8817
|
+
maxLength: 2000
|
|
8818
|
+
}
|
|
8819
|
+
},
|
|
8820
|
+
required: ['institution', 'region', 'accountType', 'format']
|
|
8821
|
+
} as const;
|
|
8822
|
+
|
|
8823
|
+
export const $ParserContributionSamplesDto = {
|
|
8824
|
+
type: 'object',
|
|
8825
|
+
properties: {
|
|
8826
|
+
rows: {
|
|
8827
|
+
description:
|
|
8828
|
+
'Client-sanitized sample rows (key = column name, value = cell)',
|
|
8829
|
+
type: 'array',
|
|
8830
|
+
items: {
|
|
8831
|
+
type: 'object'
|
|
8832
|
+
}
|
|
8833
|
+
},
|
|
8834
|
+
rawHeaders: {
|
|
8835
|
+
type: 'array',
|
|
8836
|
+
items: {
|
|
8837
|
+
type: 'string'
|
|
8838
|
+
}
|
|
8839
|
+
}
|
|
8840
|
+
},
|
|
8841
|
+
required: ['rows']
|
|
8842
|
+
} as const;
|
|
8843
|
+
|
|
8844
|
+
export const $FieldHintDto = {
|
|
8845
|
+
type: 'object',
|
|
8846
|
+
properties: {
|
|
8847
|
+
columnName: {
|
|
8848
|
+
type: 'string',
|
|
8849
|
+
example: '交易日期'
|
|
8850
|
+
},
|
|
8851
|
+
format: {
|
|
8852
|
+
type: 'string',
|
|
8853
|
+
description: 'Date format, e.g. yyyy-MM-dd HH:mm',
|
|
8854
|
+
example: 'yyyy-MM-dd'
|
|
8855
|
+
},
|
|
8856
|
+
signConvention: {
|
|
8857
|
+
type: 'string',
|
|
8858
|
+
enum: ['negative-expense', 'positive-expense', 'separate-columns']
|
|
8859
|
+
},
|
|
8860
|
+
creditColumn: {
|
|
8861
|
+
type: 'string'
|
|
8862
|
+
},
|
|
8863
|
+
debitColumn: {
|
|
8864
|
+
type: 'string'
|
|
8865
|
+
}
|
|
8866
|
+
},
|
|
8867
|
+
required: ['columnName']
|
|
8868
|
+
} as const;
|
|
8869
|
+
|
|
8870
|
+
export const $ParserContributionFieldHintsDto = {
|
|
8871
|
+
type: 'object',
|
|
8872
|
+
properties: {
|
|
8873
|
+
date: {
|
|
8874
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8875
|
+
},
|
|
8876
|
+
amount: {
|
|
8877
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8878
|
+
},
|
|
8879
|
+
description: {
|
|
8880
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8881
|
+
},
|
|
8882
|
+
balance: {
|
|
8883
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8884
|
+
},
|
|
8885
|
+
payee: {
|
|
8886
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8887
|
+
},
|
|
8888
|
+
reference: {
|
|
8889
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8890
|
+
},
|
|
8891
|
+
category: {
|
|
8892
|
+
$ref: '#/components/schemas/FieldHintDto'
|
|
8893
|
+
}
|
|
8894
|
+
},
|
|
8895
|
+
required: ['date', 'amount']
|
|
8896
|
+
} as const;
|
|
8897
|
+
|
|
8898
|
+
export const $ExpectedTransactionDto = {
|
|
8899
|
+
type: 'object',
|
|
8900
|
+
properties: {
|
|
8901
|
+
date: {
|
|
8902
|
+
type: 'string',
|
|
8903
|
+
example: '2026-08-01'
|
|
8904
|
+
},
|
|
8905
|
+
amount: {
|
|
8906
|
+
type: 'number',
|
|
8907
|
+
example: -45.5
|
|
8908
|
+
},
|
|
8909
|
+
description: {
|
|
8910
|
+
type: 'string',
|
|
8911
|
+
example: '星巴克-***店'
|
|
8912
|
+
},
|
|
8913
|
+
payee: {
|
|
8914
|
+
type: 'string'
|
|
8915
|
+
},
|
|
8916
|
+
category: {
|
|
8917
|
+
type: 'string'
|
|
8918
|
+
}
|
|
8919
|
+
},
|
|
8920
|
+
required: ['date', 'amount', 'description']
|
|
8921
|
+
} as const;
|
|
8922
|
+
|
|
8923
|
+
export const $ParserContributionExamplesDto = {
|
|
8924
|
+
type: 'object',
|
|
8925
|
+
properties: {
|
|
8926
|
+
expectedTransactions: {
|
|
8927
|
+
type: 'array',
|
|
8928
|
+
items: {
|
|
8929
|
+
$ref: '#/components/schemas/ExpectedTransactionDto'
|
|
8930
|
+
}
|
|
8931
|
+
}
|
|
8932
|
+
},
|
|
8933
|
+
required: ['expectedTransactions']
|
|
8934
|
+
} as const;
|
|
8935
|
+
|
|
8936
|
+
export const $ParserContributionRequestDto = {
|
|
8937
|
+
type: 'object',
|
|
8938
|
+
properties: {
|
|
8939
|
+
meta: {
|
|
8940
|
+
$ref: '#/components/schemas/ParserContributionMetaDto'
|
|
8941
|
+
},
|
|
8942
|
+
samples: {
|
|
8943
|
+
$ref: '#/components/schemas/ParserContributionSamplesDto'
|
|
8944
|
+
},
|
|
8945
|
+
fieldHints: {
|
|
8946
|
+
$ref: '#/components/schemas/ParserContributionFieldHintsDto'
|
|
8947
|
+
},
|
|
8948
|
+
examples: {
|
|
8949
|
+
description: 'Omitted entirely by the client when empty',
|
|
8950
|
+
allOf: [
|
|
8951
|
+
{
|
|
8952
|
+
$ref: '#/components/schemas/ParserContributionExamplesDto'
|
|
8953
|
+
}
|
|
8954
|
+
]
|
|
8955
|
+
}
|
|
8956
|
+
},
|
|
8957
|
+
required: ['meta', 'samples', 'fieldHints']
|
|
8958
|
+
} as const;
|
|
8959
|
+
|
|
8960
|
+
export const $ParserContributionRelayResponseDto = {
|
|
8961
|
+
type: 'object',
|
|
8962
|
+
properties: {
|
|
8963
|
+
issueUrl: {
|
|
8964
|
+
type: 'string',
|
|
8965
|
+
example: 'https://github.com/fire-zu/firela-vlt/issues/42'
|
|
8966
|
+
},
|
|
8967
|
+
issueNumber: {
|
|
8968
|
+
type: 'number',
|
|
8969
|
+
example: 42
|
|
8970
|
+
}
|
|
8971
|
+
},
|
|
8972
|
+
required: ['issueUrl', 'issueNumber']
|
|
8973
|
+
} as const;
|
|
8974
|
+
|
|
8398
8975
|
export const $SymbolSearchResultDto = {
|
|
8399
8976
|
type: 'object',
|
|
8400
8977
|
properties: {
|
|
@@ -8403,35 +8980,35 @@ export const $SymbolSearchResultDto = {
|
|
|
8403
8980
|
example: 'AAPL'
|
|
8404
8981
|
},
|
|
8405
8982
|
name: {
|
|
8406
|
-
type: '
|
|
8983
|
+
type: 'string',
|
|
8407
8984
|
example: 'Apple Inc.',
|
|
8408
8985
|
nullable: true
|
|
8409
8986
|
},
|
|
8410
8987
|
exchange: {
|
|
8411
|
-
type: '
|
|
8988
|
+
type: 'string',
|
|
8412
8989
|
example: 'US',
|
|
8413
8990
|
nullable: true
|
|
8414
8991
|
},
|
|
8415
8992
|
assetType: {
|
|
8416
|
-
type: '
|
|
8993
|
+
type: 'string',
|
|
8417
8994
|
description: 'OpenBB asset_type (e.g. stock, etf)',
|
|
8418
8995
|
example: 'stock',
|
|
8419
8996
|
nullable: true
|
|
8420
8997
|
},
|
|
8421
8998
|
assetClass: {
|
|
8422
|
-
type: '
|
|
8999
|
+
type: 'string',
|
|
8423
9000
|
description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
|
|
8424
9001
|
example: 'EQUITY',
|
|
8425
9002
|
nullable: true
|
|
8426
9003
|
},
|
|
8427
9004
|
assetSubClass: {
|
|
8428
|
-
type: '
|
|
9005
|
+
type: 'string',
|
|
8429
9006
|
description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
|
|
8430
9007
|
example: 'STOCK',
|
|
8431
9008
|
nullable: true
|
|
8432
9009
|
},
|
|
8433
9010
|
currency: {
|
|
8434
|
-
type: '
|
|
9011
|
+
type: 'string',
|
|
8435
9012
|
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8436
9013
|
example: 'USD',
|
|
8437
9014
|
nullable: true
|
|
@@ -8448,90 +9025,90 @@ export const $SymbolQuoteDto = {
|
|
|
8448
9025
|
example: 'AAPL'
|
|
8449
9026
|
},
|
|
8450
9027
|
name: {
|
|
8451
|
-
type: '
|
|
9028
|
+
type: 'string',
|
|
8452
9029
|
example: 'Apple Inc.',
|
|
8453
9030
|
nullable: true
|
|
8454
9031
|
},
|
|
8455
9032
|
exchange: {
|
|
8456
|
-
type: '
|
|
9033
|
+
type: 'string',
|
|
8457
9034
|
example: 'US',
|
|
8458
9035
|
nullable: true
|
|
8459
9036
|
},
|
|
8460
9037
|
assetType: {
|
|
8461
|
-
type: '
|
|
9038
|
+
type: 'string',
|
|
8462
9039
|
description: 'OpenBB asset_type',
|
|
8463
9040
|
example: 'stock',
|
|
8464
9041
|
nullable: true
|
|
8465
9042
|
},
|
|
8466
9043
|
assetClass: {
|
|
8467
|
-
type: '
|
|
9044
|
+
type: 'string',
|
|
8468
9045
|
description: 'IGN asset class',
|
|
8469
9046
|
example: 'EQUITY',
|
|
8470
9047
|
nullable: true
|
|
8471
9048
|
},
|
|
8472
9049
|
assetSubClass: {
|
|
8473
|
-
type: '
|
|
9050
|
+
type: 'string',
|
|
8474
9051
|
description: 'IGN asset sub-class',
|
|
8475
9052
|
example: 'STOCK',
|
|
8476
9053
|
nullable: true
|
|
8477
9054
|
},
|
|
8478
9055
|
currency: {
|
|
8479
|
-
type: '
|
|
9056
|
+
type: 'string',
|
|
8480
9057
|
description: 'Trading currency (extra_data or inferred from exchange)',
|
|
8481
9058
|
example: 'USD',
|
|
8482
9059
|
nullable: true
|
|
8483
9060
|
},
|
|
8484
9061
|
price: {
|
|
8485
|
-
type: '
|
|
9062
|
+
type: 'string',
|
|
8486
9063
|
description: 'Latest price (Decimal string)',
|
|
8487
9064
|
example: '189.84',
|
|
8488
9065
|
nullable: true
|
|
8489
9066
|
},
|
|
8490
9067
|
priceDate: {
|
|
8491
|
-
type: '
|
|
9068
|
+
type: 'string',
|
|
8492
9069
|
description: 'Date the price was observed (ISO yyyy-MM-dd)',
|
|
8493
9070
|
example: '2026-08-05',
|
|
8494
9071
|
nullable: true
|
|
8495
9072
|
},
|
|
8496
9073
|
changePercent: {
|
|
8497
|
-
type: '
|
|
9074
|
+
type: 'number',
|
|
8498
9075
|
description:
|
|
8499
9076
|
'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
9077
|
example: 1.7,
|
|
8501
9078
|
nullable: true
|
|
8502
9079
|
},
|
|
8503
9080
|
prevClose: {
|
|
8504
|
-
type: '
|
|
9081
|
+
type: 'string',
|
|
8505
9082
|
description: 'Previous close (Decimal string)',
|
|
8506
9083
|
nullable: true
|
|
8507
9084
|
},
|
|
8508
9085
|
open: {
|
|
8509
|
-
type: '
|
|
9086
|
+
type: 'string',
|
|
8510
9087
|
description: 'Day open (Decimal string)',
|
|
8511
9088
|
nullable: true
|
|
8512
9089
|
},
|
|
8513
9090
|
high: {
|
|
8514
|
-
type: '
|
|
9091
|
+
type: 'string',
|
|
8515
9092
|
description: 'Day high (Decimal string)',
|
|
8516
9093
|
nullable: true
|
|
8517
9094
|
},
|
|
8518
9095
|
low: {
|
|
8519
|
-
type: '
|
|
9096
|
+
type: 'string',
|
|
8520
9097
|
description: 'Day low (Decimal string)',
|
|
8521
9098
|
nullable: true
|
|
8522
9099
|
},
|
|
8523
9100
|
volume: {
|
|
8524
|
-
type: '
|
|
9101
|
+
type: 'string',
|
|
8525
9102
|
description: 'Day volume (Decimal string)',
|
|
8526
9103
|
nullable: true
|
|
8527
9104
|
},
|
|
8528
9105
|
yearHigh: {
|
|
8529
|
-
type: '
|
|
9106
|
+
type: 'string',
|
|
8530
9107
|
description: '52-week high (Decimal string)',
|
|
8531
9108
|
nullable: true
|
|
8532
9109
|
},
|
|
8533
9110
|
yearLow: {
|
|
8534
|
-
type: '
|
|
9111
|
+
type: 'string',
|
|
8535
9112
|
description: '52-week low (Decimal string)',
|
|
8536
9113
|
nullable: true
|
|
8537
9114
|
}
|