@firela/api-types 0.0.0-canary.2fbeefe9 → 0.0.0-canary.30542238

package/src/generated/schemas.gen.ts

@@ -11,7 +11,7 @@ export const $CreateAccountDto = {
     openDate: {
       format: 'date-time',
       type: 'string',
-      description: 'Account open date',
+      description: 'Account open date (server defaults to today)',
       example: '2024-01-01'
     },
     currencies: {
@@ -51,9 +51,10 @@ export const $CreateAccountDto = {
       description: 'Icon identifier (overrides template)',
       example: 'bank-custom'
     },
-    openMeta: {
+    openDirectiveMeta: {
       type: 'object',
-      description: 'Additional metadata',
+      description:
+        'Open directive metadata (NOT an opening-balance amount — use the opening-balance endpoint)',
       example: {
         branch: 'Downtown',
         accountNumber: '1234'
@@ -65,7 +66,7 @@ export const $CreateAccountDto = {
       example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
     }
   },
-  required: ['path', 'openDate']
+  required: ['path']
 } as const;
 
 export const $AccountResponseDto = {
@@ -87,6 +88,49 @@ export const $AccountResponseDto = {
       enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
       example: 'Assets'
     },
+    assetSubClass: {
+      type: 'string',
+      description:
+        'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
+      enum: [
+        'DEPOSIT',
+        'CASH',
+        'MONEY_MARKET_FUND',
+        'STOCK',
+        'ETF',
+        'MUTUAL_FUND',
+        'EQUITY_COMPENSATION',
+        'GOVERNMENT_BOND',
+        'CORPORATE_BOND',
+        'BOND_FUND',
+        'PRIMARY_RESIDENCE',
+        'INVESTMENT_PROPERTY',
+        'REIT',
+        'GOLD',
+        'SILVER',
+        'PRECIOUS_METAL',
+        'PRECIOUS_METAL_FUND',
+        'COMMODITY',
+        'COMMODITY_FUND',
+        'CRYPTOCURRENCY',
+        'RETIREMENT_ACCOUNT',
+        'HEALTH_ACCOUNT',
+        'EDUCATION_ACCOUNT',
+        'INSURANCE',
+        'PRIVATE_EQUITY',
+        'HEDGE_FUND',
+        'COLLECTIBLES',
+        'MORTGAGE',
+        'STUDENT_LOAN',
+        'CREDIT_CARD',
+        'PERSONAL_LOAN',
+        'ACCOUNTS_PAYABLE',
+        'TAX_PAYABLE',
+        'OTHER'
+      ],
+      nullable: true,
+      example: 'STOCK'
+    },
     status: {
       type: 'string',
       description: 'Account status',
@@ -145,9 +189,9 @@ export const $AccountResponseDto = {
       description: 'Icon identifier',
       example: 'bank-icbc'
     },
-    openMeta: {
+    openDirectiveMeta: {
       type: 'object',
-      description: 'Account metadata',
+      description: 'Open directive metadata (ADR-0115 Decision 9)',
       example: {
         branch: 'Downtown'
       }
@@ -233,9 +277,10 @@ export const $UpdateAccountDto = {
       description: 'Icon identifier',
       example: 'bank-custom'
     },
-    openMeta: {
+    openDirectiveMeta: {
       type: 'object',
-      description: 'Additional metadata (merged with existing)',
+      description:
+        'Open directive metadata (merged with existing; NOT an opening-balance amount)',
       example: {
         branch: 'Uptown'
       }
@@ -282,6 +327,40 @@ export const $ReopenAccountDto = {
   }
 } as const;
 
+export const $CreateOpeningBalanceDto = {
+  type: 'object',
+  properties: {
+    amount: {
+      type: 'number',
+      description: 'Opening balance amount (non-negative)',
+      example: 1000
+    },
+    currency: {
+      type: 'string',
+      description: 'Currency code',
+      example: 'CNY'
+    },
+    date: {
+      format: 'date-time',
+      type: 'string',
+      description: 'Opening-balance date (defaults to now)',
+      example: '2024-01-01'
+    }
+  },
+  required: ['amount', 'currency']
+} as const;
+
+export const $OpeningBalanceResultDto = {
+  type: 'object',
+  properties: {
+    transactionId: {
+      type: 'string',
+      description: 'Created opening-balance transaction id.'
+    }
+  },
+  required: ['transactionId']
+} as const;
+
 export const $AccountStandardResponseDto = {
   type: 'object',
   properties: {
@@ -318,9 +397,47 @@ export const $AccountStandardResponseDto = {
       type: 'string',
       description: 'Icon identifier for UI display',
       example: 'bank-icbc'
+    },
+    productCategory: {
+      type: 'string',
+      description:
+        'Onboarding product category (coarse grouping derived from assetSubClass)',
+      enum: [
+        'cash',
+        'investment',
+        'credit_card',
+        'loan',
+        'payable_tax',
+        'other'
+      ],
+      example: 'investment'
+    },
+    assetClass: {
+      type: 'string',
+      description:
+        'Asset class (LIQUIDITY/EQUITY/.../LIABILITY), derived at read time from classification rules',
+      enum: [
+        'LIQUIDITY',
+        'EQUITY',
+        'FIXED_INCOME',
+        'PRECIOUS_METALS',
+        'COMMODITY',
+        'INSURANCE',
+        'ALTERNATIVE_INVESTMENT',
+        'PERSONAL_ASSETS',
+        'LIABILITY',
+        'REAL_ESTATE',
+        'INDEX'
+      ]
+    },
+    assetSubClass: {
+      type: 'string',
+      description:
+        'Asset sub-class (product type, derived at read time from classification rules)',
+      example: 'STOCK'
     }
   },
-  required: ['path', 'type', 'description', 'tags', 'icon']
+  required: ['path', 'type', 'description', 'tags', 'icon', 'productCategory']
 } as const;
 
 export const $AccountStandardListResponseDto = {
@@ -659,7 +776,7 @@ export const $PostingResponseDto = {
     units: {
       type: 'string',
       description:
-        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
+        '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.',
       example: '100.50'
     },
     currency: {
@@ -1025,7 +1142,7 @@ export const $PostingDetailDto = {
     units: {
       type: 'string',
       description:
-        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
+        '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.',
       example: '100.50'
     },
     currency: {
@@ -1209,6 +1326,147 @@ export const $TransactionDetailDto = {
   ]
 } as const;
 
+export const $TransactionListItemDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'Transaction ID',
+      example: 'clh1234567890abcdef'
+    },
+    date: {
+      type: 'string',
+      description: 'Transaction date',
+      example: '2024-11-28'
+    },
+    flag: {
+      type: 'string',
+      description: 'Transaction flag',
+      enum: [
+        'CLEARED',
+        'PENDING',
+        'PADDING',
+        'SUMMARIZE',
+        'TRANSFER',
+        'CONVERSIONS'
+      ],
+      example: 'CLEARED'
+    },
+    customFlag: {
+      type: 'string',
+      description: 'Custom flag (if not using standard flags)',
+      example: 'R'
+    },
+    payee: {
+      type: 'string',
+      description: 'Payee name',
+      example: 'Whole Foods Market'
+    },
+    narration: {
+      type: 'string',
+      description: 'Transaction narration',
+      example: 'Grocery shopping'
+    },
+    tags: {
+      description: 'Transaction tags',
+      example: ['groceries'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    links: {
+      description: 'Transaction links',
+      example: ['invoice-2024-001'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    meta: {
+      type: 'object',
+      description: 'Transaction metadata'
+    },
+    status: {
+      type: 'string',
+      description: 'Transaction status',
+      enum: ['ACTIVE', 'VOIDED', 'SUPERSEDED'],
+      example: 'ACTIVE'
+    },
+    sourceType: {
+      type: 'string',
+      description:
+        'Source type (free-form string from transaction metadata, e.g. import, api)'
+    },
+    sourcePlatform: {
+      type: 'string',
+      description: 'Source platform (e.g., alipay, wechat)',
+      example: 'alipay'
+    },
+    postings: {
+      description: 'Transaction postings',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/PostingDetailDto'
+      }
+    },
+    createdAt: {
+      type: 'string',
+      description: 'Created at timestamp',
+      example: '2024-11-28T10:30:00.000Z'
+    },
+    voidedAt: {
+      type: 'string',
+      description: 'Voided at timestamp (if voided)',
+      example: '2024-11-29T15:00:00.000Z'
+    },
+    voidedBy: {
+      type: 'string',
+      description: 'User ID who voided this transaction',
+      example: 'clh1234567890abcdef'
+    },
+    correctionReason: {
+      type: 'string',
+      description: 'Correction reason (if voided or superseded)',
+      example: 'Duplicate entry'
+    },
+    supersededBy: {
+      type: 'string',
+      description:
+        'ID of the transaction that supersedes this one (set when status=SUPERSEDED)',
+      example: 'clh1234567890abcdef'
+    },
+    originalTxn: {
+      type: 'string',
+      description:
+        'ID of the transaction this one corrected/replaced (back-link on the replacement)',
+      example: 'clh1234567890abcdef'
+    },
+    viewpointAmount: {
+      type: 'string',
+      description:
+        '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.',
+      example: '10000.00'
+    },
+    viewpointCurrency: {
+      type: 'string',
+      description:
+        'Currency of viewpointAmount. A row spanning multiple currencies takes the largest-magnitude currency group (known simplification, ADR-0126).',
+      example: 'CNY'
+    }
+  },
+  required: [
+    'id',
+    'date',
+    'narration',
+    'tags',
+    'links',
+    'status',
+    'postings',
+    'createdAt'
+  ]
+} as const;
+
 export const $BalanceByCurrencyDto = {
   type: 'object',
   properties: {
@@ -1254,7 +1512,7 @@ export const $TransactionListSummaryDto = {
     totalAmount: {
       type: 'string',
       description:
-        'Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.',
+        '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.',
       example: '-6000.00'
     },
     currency: {
@@ -1280,6 +1538,26 @@ export const $TransactionListSummaryDto = {
   required: ['totalAmount', 'currency', 'balanceByCurrency']
 } as const;
 
+export const $TransactionListViewpointDto = {
+  type: 'object',
+  properties: {
+    type: {
+      type: 'string',
+      description:
+        'Viewpoint type (only category drill-down carries a viewpoint today)',
+      enum: ['category'],
+      example: 'category'
+    },
+    flow: {
+      type: 'string',
+      description: 'Flow root the category account set is restricted to',
+      enum: ['income', 'expense'],
+      example: 'expense'
+    }
+  },
+  required: ['type', 'flow']
+} as const;
+
 export const $TransactionListResponseDto = {
   type: 'object',
   properties: {
@@ -1287,7 +1565,7 @@ export const $TransactionListResponseDto = {
       description: 'List of transactions',
       type: 'array',
       items: {
-        $ref: '#/components/schemas/TransactionDetailDto'
+        $ref: '#/components/schemas/TransactionListItemDto'
       }
     },
     total: {
@@ -1313,6 +1591,15 @@ export const $TransactionListResponseDto = {
           $ref: '#/components/schemas/TransactionListSummaryDto'
         }
       ]
+    },
+    viewpoint: {
+      description:
+        '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).',
+      allOf: [
+        {
+          $ref: '#/components/schemas/TransactionListViewpointDto'
+        }
+      ]
     }
   },
   required: ['data', 'total', 'limit', 'offset']
@@ -3715,24 +4002,515 @@ export const $ForecastResponseDto = {
   ]
 } as const;
 
-export const $CreateTransactionRuleDto = {
+export const $CurrencyBalanceDto = {
   type: 'object',
   properties: {
-    name: {
+    currency: {
       type: 'string',
-      minLength: 1,
-      maxLength: 100
+      description: 'ISO 4217 currency code',
+      example: 'CNY'
     },
-    description: {
+    balance: {
       type: 'string',
-      maxLength: 500
+      description: 'Balance amount',
+      example: '500000.00'
+    }
+  },
+  required: ['currency', 'balance']
+} as const;
+
+export const $TimeSeriesPointDto = {
+  type: 'object',
+  properties: {
+    date: {
+      type: 'string',
+      description: 'Date in YYYY-MM-DD format',
+      example: '2024-06-15'
     },
-    narrationKeywords: {
-      items: {
-        type: 'array'
-      },
-      maxItems: 50,
-      type: 'array'
+    value: {
+      type: 'string',
+      description: 'Value at this date (in base currency)',
+      example: '500000.00'
+    },
+    change: {
+      type: 'object',
+      description: 'Change from previous point',
+      example: '5000.00'
+    },
+    assets: {
+      type: 'string',
+      description: 'Total assets at this date (in base currency)',
+      example: '494338.00'
+    },
+    liabilities: {
+      type: 'string',
+      description: 'Total liabilities at this date (in base currency)',
+      example: '310098.00'
+    },
+    byCurrency: {
+      description: 'Multi-currency breakdown for this point',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CurrencyBalanceDto'
+      }
+    }
+  },
+  required: ['date', 'value']
+} as const;
+
+export const $TrendSummaryDto = {
+  type: 'object',
+  properties: {
+    startValue: {
+      type: 'string',
+      description: 'Value at start of period',
+      example: '450000.00'
+    },
+    endValue: {
+      type: 'string',
+      description: 'Value at end of period',
+      example: '500000.00'
+    },
+    totalChange: {
+      type: 'string',
+      description: 'Total change over period',
+      example: '50000.00'
+    },
+    totalChangePercentage: {
+      type: 'string',
+      description: 'Total change percentage',
+      example: '+11.11%'
+    }
+  },
+  required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
+} as const;
+
+export const $MultiCurrencyPointDto = {
+  type: 'object',
+  properties: {
+    date: {
+      type: 'string',
+      description: 'Date in YYYY-MM-DD format',
+      example: '2024-06-15'
+    },
+    byCurrency: {
+      description: 'Balances by currency',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CurrencyBalanceDto'
+      }
+    }
+  },
+  required: ['date', 'byCurrency']
+} as const;
+
+export const $PortfolioTrendsResponseDto = {
+  type: 'object',
+  properties: {
+    series: {
+      description: 'Time series data points',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/TimeSeriesPointDto'
+      }
+    },
+    summary: {
+      description: 'Period summary',
+      allOf: [
+        {
+          $ref: '#/components/schemas/TrendSummaryDto'
+        }
+      ]
+    },
+    period: {
+      type: 'string',
+      description: 'Period requested',
+      example: '6m'
+    },
+    granularity: {
+      type: 'string',
+      description: 'Data granularity',
+      example: 'month'
+    },
+    currency: {
+      type: 'string',
+      description: 'Base currency for converted values',
+      example: 'CNY'
+    },
+    byCurrency: {
+      description:
+        'Multi-currency time series (each point has currency breakdown)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/MultiCurrencyPointDto'
+      }
+    },
+    warnings: {
+      description: 'Exchange rate warnings',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExchangeRateWarningDto'
+      }
+    }
+  },
+  required: ['series', 'summary', 'period', 'granularity', 'currency']
+} as const;
+
+export const $CashFlowPointDto = {
+  type: 'object',
+  properties: {
+    month: {
+      type: 'string',
+      description: 'Month key (YYYY-MM)',
+      example: '2024-03'
+    },
+    income: {
+      type: 'string',
+      description: 'Income in base currency (absolute, converted)',
+      example: '10000.00'
+    },
+    expense: {
+      type: 'string',
+      description: 'Expense in base currency (absolute, converted)',
+      example: '5000.00'
+    },
+    netSavings: {
+      type: 'string',
+      description: 'netSavings = income − expense (savings positive)',
+      example: '5000.00'
+    }
+  },
+  required: ['month', 'income', 'expense', 'netSavings']
+} as const;
+
+export const $CashFlowTrendSummaryDto = {
+  type: 'object',
+  properties: {
+    totalIncome: {
+      type: 'string',
+      description: 'Total income across the period',
+      example: '60000.00'
+    },
+    totalExpense: {
+      type: 'string',
+      description: 'Total expense across the period',
+      example: '30000.00'
+    },
+    totalNetSavings: {
+      type: 'string',
+      description: 'income − expense across the period',
+      example: '30000.00'
+    },
+    averageMonthlyNetSavings: {
+      type: 'string',
+      description:
+        'totalNetSavings divided by the window length (N months, incl. zero-filled)',
+      example: '5000.00'
+    }
+  },
+  required: [
+    'totalIncome',
+    'totalExpense',
+    'totalNetSavings',
+    'averageMonthlyNetSavings'
+  ]
+} as const;
+
+export const $CashFlowTrendsResponseDto = {
+  type: 'object',
+  properties: {
+    series: {
+      description:
+        'Monthly cash-flow series (fixed N-month window, zero-filled)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CashFlowPointDto'
+      }
+    },
+    summary: {
+      description: 'Period totals',
+      allOf: [
+        {
+          $ref: '#/components/schemas/CashFlowTrendSummaryDto'
+        }
+      ]
+    },
+    period: {
+      type: 'string',
+      description: 'Period requested',
+      example: '6m'
+    },
+    granularity: {
+      type: 'string',
+      description: 'Data granularity (v1 returns month buckets)',
+      example: 'month'
+    },
+    currency: {
+      type: 'string',
+      description: 'Base currency for converted values',
+      example: 'CNY'
+    },
+    warnings: {
+      description: 'Exchange rate warnings (e.g. missing rate for a currency)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExchangeRateWarningDto'
+      }
+    }
+  },
+  required: ['series', 'summary', 'period', 'granularity', 'currency']
+} as const;
+
+export const $GenerateSnapshotBody = {
+  type: 'object',
+  properties: {}
+} as const;
+
+export const $GenerateSnapshotResponse = {
+  type: 'object',
+  properties: {}
+} as const;
+
+export const $BackfillSnapshotsBody = {
+  type: 'object',
+  properties: {}
+} as const;
+
+export const $BackfillSnapshotsResponse = {
+  type: 'object',
+  properties: {}
+} as const;
+
+export const $DeleteOwnUserDto = {
+  type: 'object',
+  properties: {
+    accessToken: {
+      type: 'string',
+      description: 'Access token for user verification',
+      example: 'abc123xyz'
+    }
+  },
+  required: ['accessToken']
+} as const;
+
+export const $UserSettingsResponseDto = {
+  type: 'object',
+  properties: {
+    baseCurrency: {
+      type: 'string',
+      description:
+        'Base currency (ISO 4217) for net-worth/report aggregation. Independent of region (ADR-0006).',
+      example: 'USD',
+      nullable: true
+    }
+  },
+  required: ['baseCurrency']
+} as const;
+
+export const $UserResponseDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'User ID'
+    },
+    role: {
+      type: 'string',
+      description: 'Assigned user role'
+    },
+    permissions: {
+      description: 'Permission strings',
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    settings: {
+      description: 'User settings',
+      allOf: [
+        {
+          $ref: '#/components/schemas/UserSettingsResponseDto'
+        }
+      ]
+    }
+  },
+  required: ['id', 'role', 'permissions', 'settings']
+} as const;
+
+export const $SignupDto = {
+  type: 'object',
+  properties: {
+    turnstileToken: {
+      type: 'string',
+      description:
+        'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
+      example: '0.abc123def456...'
+    }
+  }
+} as const;
+
+export const $SignupResponseDto = {
+  type: 'object',
+  properties: {
+    authToken: {
+      type: 'string',
+      description: 'JWT auth token',
+      example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+    },
+    accessToken: {
+      type: 'string',
+      description: 'Auto-generated access token'
+    },
+    role: {
+      type: 'string',
+      description: 'Assigned user role',
+      enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
+    }
+  },
+  required: ['authToken', 'accessToken', 'role']
+} as const;
+
+export const $UpdateUserSettingDto = {
+  type: 'object',
+  properties: {
+    secId: {
+      type: 'number',
+      description: 'Security ID'
+    },
+    annualInterestRate: {
+      type: 'number',
+      description: 'Annual interest rate',
+      example: 0.05
+    },
+    currency: {
+      type: 'string',
+      description: 'Currency code',
+      example: 'USD'
+    },
+    baseCurrency: {
+      type: 'string',
+      description: 'Base currency code',
+      example: 'USD'
+    },
+    benchmark: {
+      type: 'string',
+      description: 'Benchmark symbol',
+      example: 'SPY'
+    },
+    colorScheme: {
+      type: 'string',
+      description: 'Color scheme',
+      enum: ['DARK', 'LIGHT']
+    },
+    dateRange: {
+      type: 'string',
+      description: 'Date range filter',
+      example: '1y'
+    },
+    emergencyFund: {
+      type: 'number',
+      description: 'Emergency fund amount',
+      example: 10000
+    },
+    'filters.accounts': {
+      description: 'Account filter IDs',
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    'filters.assetClasses': {
+      description: 'Asset class filters',
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    'filters.dataSource': {
+      type: 'string',
+      description: 'Data source filter'
+    },
+    'filters.symbol': {
+      type: 'string',
+      description: 'Symbol filter'
+    },
+    'filters.tags': {
+      description: 'Tag filters',
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    isExperimentalFeatures: {
+      type: 'boolean',
+      description: 'Enable experimental features'
+    },
+    isRestrictedView: {
+      type: 'boolean',
+      description: 'Enable restricted view mode'
+    },
+    language: {
+      type: 'string',
+      description: 'Language code',
+      example: 'en'
+    },
+    locale: {
+      type: 'string',
+      description: 'Locale code',
+      example: 'en-US'
+    },
+    projectedTotalAmount: {
+      type: 'number',
+      description: 'Projected total amount',
+      example: 1000000
+    },
+    retirementDate: {
+      type: 'string',
+      description: 'Retirement date in ISO 8601 format',
+      example: '2050-01-01'
+    },
+    savingsRate: {
+      type: 'number',
+      description: 'Savings rate percentage',
+      example: 0.2
+    },
+    viewMode: {
+      type: 'string',
+      description: 'View mode',
+      enum: ['DEFAULT', 'ZEN']
+    }
+  }
+} as const;
+
+export const $UpdatePropertyDto = {
+  type: 'object',
+  properties: {
+    value: {
+      type: 'string',
+      description: 'Property value'
+    }
+  },
+  required: ['value']
+} as const;
+
+export const $CreateTransactionRuleDto = {
+  type: 'object',
+  properties: {
+    name: {
+      type: 'string',
+      minLength: 1,
+      maxLength: 100
+    },
+    description: {
+      type: 'string',
+      maxLength: 500
+    },
+    narrationKeywords: {
+      items: {
+        type: 'array'
+      },
+      maxItems: 50,
+      type: 'array'
     },
     payeeKeywords: {
       items: {
@@ -4364,151 +5142,67 @@ export const $TestRuleResponseDto = {
   required: ['ruleId', 'matches', 'confidence', 'matchDetails']
 } as const;
 
-export const $DeleteOwnUserDto = {
-  type: 'object',
-  properties: {
-    accessToken: {
-      type: 'string',
-      description: 'Access token for user verification',
-      example: 'abc123xyz'
-    }
-  },
-  required: ['accessToken']
-} as const;
-
-export const $SignupDto = {
-  type: 'object',
-  properties: {
-    turnstileToken: {
-      type: 'string',
-      description:
-        'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
-      example: '0.abc123def456...'
-    }
-  }
-} as const;
-
-export const $UpdateUserSettingDto = {
+export const $CategoryCatalogEntryDto = {
   type: 'object',
   properties: {
-    secId: {
-      type: 'number',
-      description: 'Security ID'
-    },
-    annualInterestRate: {
-      type: 'number',
-      description: 'Annual interest rate',
-      example: 0.05
-    },
-    currency: {
-      type: 'string',
-      description: 'Currency code',
-      example: 'USD'
-    },
-    baseCurrency: {
-      type: 'string',
-      description: 'Base currency code',
-      example: 'USD'
-    },
-    benchmark: {
+    slug: {
       type: 'string',
-      description: 'Benchmark symbol',
-      example: 'SPY'
+      description: 'Category slug (single source-of-truth)',
+      example: 'food'
     },
-    colorScheme: {
+    scenario: {
       type: 'string',
-      description: 'Color scheme',
-      enum: ['DARK', 'LIGHT']
+      description: 'Display scenario group (maps to frontend picker _scenario)',
+      enum: [
+        'expense',
+        'income',
+        'investment',
+        'banking',
+        'transfer',
+        'payment'
+      ],
+      example: 'expense'
     },
-    dateRange: {
+    icon: {
       type: 'string',
-      description: 'Date range filter',
-      example: '1y'
-    },
-    emergencyFund: {
-      type: 'number',
-      description: 'Emergency fund amount',
-      example: 10000
-    },
-    'filters.accounts': {
-      description: 'Account filter IDs',
-      type: 'array',
-      items: {
-        type: 'string'
-      }
+      description: 'Lucide icon name',
+      example: 'utensils'
     },
-    'filters.assetClasses': {
-      description: 'Asset class filters',
+    regions: {
+      description: "Applicable regions ('*' = all, 'cn' = CN-only)",
+      example: ['*'],
       type: 'array',
       items: {
         type: 'string'
       }
-    },
-    'filters.dataSource': {
-      type: 'string',
-      description: 'Data source filter'
-    },
-    'filters.symbol': {
-      type: 'string',
-      description: 'Symbol filter'
-    },
-    'filters.tags': {
-      description: 'Tag filters',
+    }
+  },
+  required: ['slug', 'scenario', 'icon', 'regions']
+} as const;
+
+export const $CategoryCatalogListResponseDto = {
+  type: 'object',
+  properties: {
+    items: {
+      description: 'Category entries (region-scoped, query-filtered)',
       type: 'array',
       items: {
-        type: 'string'
+        $ref: '#/components/schemas/CategoryCatalogEntryDto'
       }
     },
-    isExperimentalFeatures: {
-      type: 'boolean',
-      description: 'Enable experimental features'
-    },
-    isRestrictedView: {
-      type: 'boolean',
-      description: 'Enable restricted view mode'
-    },
-    language: {
-      type: 'string',
-      description: 'Language code',
-      example: 'en'
-    },
-    locale: {
-      type: 'string',
-      description: 'Locale code',
-      example: 'en-US'
-    },
-    projectedTotalAmount: {
-      type: 'number',
-      description: 'Projected total amount',
-      example: 1000000
-    },
-    retirementDate: {
-      type: 'string',
-      description: 'Retirement date in ISO 8601 format',
-      example: '2050-01-01'
-    },
-    savingsRate: {
+    total: {
       type: 'number',
-      description: 'Savings rate percentage',
-      example: 0.2
+      description:
+        'Total category entries for the region (before query filtering)',
+      example: 30
     },
-    viewMode: {
-      type: 'string',
-      description: 'View mode',
-      enum: ['DEFAULT', 'ZEN']
-    }
-  }
-} as const;
-
-export const $UpdatePropertyDto = {
-  type: 'object',
-  properties: {
-    value: {
+    region: {
       type: 'string',
-      description: 'Property value'
+      description: 'Region code',
+      example: 'cn'
     }
   },
-  required: ['value']
+  required: ['items', 'total', 'region']
 } as const;
 
 export const $CreateBeanEventDto = {
@@ -5253,7 +5947,8 @@ export const $UpdateMapperDefaultsDto = {
       type: 'string',
       description: 'Source account for transactions (Beancount format)',
       example: 'Assets:CN:Alipay:Balance',
-      pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
+      pattern:
+        '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
     },
     currency: {
       type: 'string',
@@ -5267,13 +5962,15 @@ export const $UpdateMapperDefaultsDto = {
       type: 'string',
       description: 'Default expense account (optional)',
       example: 'Expenses:Unknown',
-      pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
+      pattern:
+        '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
     },
     incomeAccount: {
       type: 'string',
       description: 'Default income account (optional)',
       example: 'Income:Unknown',
-      pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
+      pattern:
+        '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
     },
     methodAccountMapping: {
       type: 'object',
@@ -5330,12 +6027,14 @@ export const $ProviderSyncConfigDto = {
     },
     defaultExpenseAccount: {
       type: 'string',
-      description: 'Default expense account for the second posting',
+      description:
+        'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
       example: 'Expenses:Unknown'
     },
     defaultIncomeAccount: {
       type: 'string',
-      description: 'Default income account for the second posting',
+      description:
+        'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
       example: 'Income:Unknown'
     },
     filterPending: {
@@ -5350,12 +6049,7 @@ export const $ProviderSyncConfigDto = {
       example: 'acc_gocardless_001'
     }
   },
-  required: [
-    'sourceAccount',
-    'defaultCurrency',
-    'defaultExpenseAccount',
-    'defaultIncomeAccount'
-  ]
+  required: ['sourceAccount', 'defaultCurrency']
 } as const;
 
 export const $ProviderSyncDto = {
@@ -5565,15 +6259,105 @@ export const $UncoveredFormatMissDto = {
   properties: {}
 } as const;
 
+export const $ClientParsedDataDto = {
+  type: 'object',
+  properties: {
+    amount: {
+      type: 'number',
+      description: 'Transaction amount',
+      example: 35
+    },
+    currency: {
+      type: 'string',
+      description: 'Currency code',
+      example: 'CNY'
+    },
+    date: {
+      type: 'string',
+      description: 'Transaction date (ISO 8601)',
+      example: '2026-08-15'
+    },
+    payee: {
+      type: 'string',
+      description: 'Payee/merchant name',
+      example: 'Starbucks'
+    },
+    narration: {
+      type: 'string',
+      description: 'Transaction narration'
+    },
+    category: {
+      type: 'string',
+      description: 'Category slug',
+      example: 'food_restaurant'
+    },
+    incomeType: {
+      type: 'string',
+      description: 'Income type',
+      example: 'Salary'
+    },
+    incomeSource: {
+      type: 'string',
+      description: 'Income source',
+      example: 'Anthropic Inc.'
+    },
+    symbol: {
+      type: 'string',
+      description: 'Security symbol code (e.g., 600519, AAPL)',
+      example: 'AAPL'
+    },
+    quantity: {
+      type: 'number',
+      description: 'Quantity of shares/units',
+      example: 100
+    },
+    price: {
+      type: 'number',
+      description: 'Unit price per share/unit',
+      example: 1900
+    },
+    investmentAction: {
+      type: 'string',
+      description: 'Investment action',
+      enum: ['buy', 'sell'],
+      example: 'buy'
+    },
+    paymentSource: {
+      type: 'string',
+      description: 'Payment source: asset (default) or liability (credit card)',
+      enum: ['asset', 'liability'],
+      example: 'asset'
+    },
+    liabilityHint: {
+      type: 'string',
+      description: 'Liability account hint (CreditCard/Huabei/Baitiao)',
+      example: 'CreditCard'
+    },
+    warning: {
+      type: 'string',
+      description:
+        'Display-only warning from the prior response; accepted but ignored.',
+      example: 'Cross-currency settlement applies.'
+    }
+  }
+} as const;
+
 export const $ProcessNlpDto = {
   type: 'object',
   properties: {
     message: {
       type: 'string',
-      description: 'Natural language text describing a transaction (Chinese)',
-      example: 'yesterday Starbucks spent 35 yuan',
+      description:
+        'Natural language text describing a transaction. Optional when `confirm` is true (structured confirm); otherwise required.',
+      example: 'Starbucks 35',
       maxLength: 500
     },
+    confirm: {
+      type: 'boolean',
+      description:
+        'Structured confirm signal — bypasses NL confirm-word matching when true. Send parsedData field edits alongside. The NL word-list path is the fallback.',
+      example: true
+    },
     sessionId: {
       type: 'string',
       description:
@@ -5581,17 +6365,32 @@ export const $ProcessNlpDto = {
       example: 'session_abc123'
     },
     parsedData: {
-      type: 'object',
       description:
         'Parsed data from previous NLP response for session recovery. Send back the parsedData received in confirm_payee/confirm responses.',
       example: {
         amount: 35,
         currency: 'CNY',
         payee: 'Starbucks'
-      }
+      },
+      allOf: [
+        {
+          $ref: '#/components/schemas/ClientParsedDataDto'
+        }
+      ]
+    },
+    selectedRuleId: {
+      type: 'string',
+      description:
+        'confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.',
+      example: 'rule_abc123'
+    },
+    selectedAccount: {
+      type: 'string',
+      description:
+        '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.',
+      example: 'Expenses:Food:Coffee'
     }
-  },
-  required: ['message']
+  }
 } as const;
 
 export const $NlpTransactionInfoDto = {
@@ -5894,13 +6693,31 @@ export const $NlpRuleConfirmationDataDto = {
       }
     }
   },
-  required: [
-    'confidence',
-    'matchedRule',
-    'suggestedAccounts',
-    'alternatives',
-    'reasons'
-  ]
+  required: [
+    'confidence',
+    'matchedRule',
+    'suggestedAccounts',
+    'alternatives',
+    'reasons'
+  ]
+} as const;
+
+export const $NlpAccountCandidateDto = {
+  type: 'object',
+  properties: {
+    path: {
+      type: 'string',
+      description: 'Canonical beancount account path (echo back on selection)',
+      example: 'Expenses:Food:Dining'
+    },
+    name: {
+      type: 'string',
+      description:
+        'Localized display name (ADR-0114 read-time projection, user locale)',
+      example: '餐饮'
+    }
+  },
+  required: ['path', 'name']
 } as const;
 
 export const $NlpAccountConfirmationDataDto = {
@@ -5913,14 +6730,16 @@ export const $NlpAccountConfirmationDataDto = {
     },
     suggestedAccount: {
       type: 'string',
-      description: 'Suggested replacement account',
+      description:
+        'Suggested replacement account (omitted when no clear candidate)',
       example: 'Expenses:Food:Drinks'
     },
     similarAccounts: {
-      description: 'Similar accounts for user selection',
+      description:
+        'Similar accounts for user selection (path + localized name, #680)',
       type: 'array',
       items: {
-        type: 'string'
+        $ref: '#/components/schemas/NlpAccountCandidateDto'
       }
     },
     errorMessage: {
@@ -5935,7 +6754,6 @@ export const $NlpAccountConfirmationDataDto = {
   },
   required: [
     'invalidAccount',
-    'suggestedAccount',
     'similarAccounts',
     'errorMessage',
     'transactionContext'
@@ -6108,7 +6926,8 @@ export const $NlpSuggestedAccountDto = {
     },
     confidence: {
       type: 'number',
-      description: 'Confidence score for this suggestion (0-1)',
+      description:
+        'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
       example: 0.9
     }
   },
@@ -6144,23 +6963,31 @@ export const $NlpDefaultAccountsDto = {
   properties: {
     asset: {
       type: 'string',
-      description: 'Default asset account',
-      example: 'Assets:Checking'
+      description:
+        'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
+      example: 'Assets:Checking',
+      nullable: true
     },
     expense: {
       type: 'string',
-      description: 'Default expense account',
-      example: 'Expenses:Uncategorized'
+      description:
+        'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
+      example: 'Expenses:Food:Coffee',
+      nullable: true
     },
     income: {
       type: 'string',
-      description: 'Default income account',
-      example: 'Income:Uncategorized'
+      description:
+        'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
+      example: 'Income:Salary',
+      nullable: true
     },
     liability: {
       type: 'string',
-      description: 'Default liability account',
-      example: 'Liabilities:CreditCard'
+      description:
+        'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
+      example: 'Liabilities:CreditCard',
+      nullable: true
     }
   },
   required: ['asset', 'expense', 'income', 'liability']
@@ -6185,7 +7012,8 @@ export const $NlpResponseDto = {
         'confirm_rule',
         'confirm_account',
         'confirm_payee',
-        'cancel'
+        'cancel',
+        'aborted'
       ]
     },
     intent: {
@@ -6199,7 +7027,7 @@ export const $NlpResponseDto = {
       type: 'string',
       description:
         'Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.',
-      enum: ['transfer', 'banking', 'investment'],
+      enum: ['transfer', 'banking', 'investment', 'lend', 'lend_collect'],
       example: 'investment'
     },
     liabilitySubType: {
@@ -6347,7 +7175,7 @@ export const $NlpResponseDto = {
     },
     suggestedAccounts: {
       description:
-        'Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.',
+        'Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.',
       allOf: [
         {
           $ref: '#/components/schemas/NlpSuggestedAccountsDto'
@@ -6356,7 +7184,7 @@ export const $NlpResponseDto = {
     },
     defaultAccounts: {
       description:
-        'Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.',
+        'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
       allOf: [
         {
           $ref: '#/components/schemas/NlpDefaultAccountsDto'
@@ -6367,6 +7195,178 @@ export const $NlpResponseDto = {
   required: ['status', 'action']
 } as const;
 
+export const $PlatformListItemDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'Global platform ID'
+    },
+    name: {
+      type: 'string',
+      description: 'Platform name'
+    },
+    url: {
+      type: 'string',
+      description: 'Platform URL'
+    },
+    type: {
+      type: 'string',
+      description: 'Platform type',
+      enum: [
+        'BANK',
+        'BROKERAGE',
+        'CRYPTO_EXCHANGE',
+        'PAYMENT',
+        'INVESTMENT',
+        'INSURANCE',
+        'OTHER'
+      ]
+    },
+    canonical: {
+      type: 'string',
+      description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
+    },
+    suggestedSegment: {
+      type: 'string',
+      description:
+        'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
+    },
+    logoUrl: {
+      type: 'string',
+      description: 'Logo URL',
+      nullable: true
+    },
+    countryCode: {
+      type: 'string',
+      description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
+      example: 'CN',
+      nullable: true
+    },
+    category: {
+      type: 'string',
+      description:
+        'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
+      nullable: true,
+      example: 'DigitalWallet'
+    },
+    isBound: {
+      type: 'boolean',
+      description: 'Whether user has accounts using this platform'
+    }
+  },
+  required: [
+    'id',
+    'name',
+    'url',
+    'type',
+    'canonical',
+    'suggestedSegment',
+    'logoUrl',
+    'countryCode',
+    'category',
+    'isBound'
+  ]
+} as const;
+
+export const $PlatformMatchResultDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'Global platform ID'
+    },
+    name: {
+      type: 'string',
+      description: 'Platform name (e.g., "ICBC")'
+    },
+    canonical: {
+      type: 'string',
+      description: 'Canonical identifier in ACCOUNT_RE format (e.g., "icbc")'
+    },
+    type: {
+      type: 'string',
+      description: 'Platform type',
+      enum: [
+        'BANK',
+        'BROKERAGE',
+        'CRYPTO_EXCHANGE',
+        'PAYMENT',
+        'INVESTMENT',
+        'INSURANCE',
+        'OTHER'
+      ]
+    },
+    suggestedSegment: {
+      type: 'string',
+      description:
+        'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
+    },
+    logoUrl: {
+      type: 'string',
+      description: 'Logo URL',
+      nullable: true
+    },
+    countryCode: {
+      type: 'string',
+      description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
+      example: 'CN',
+      nullable: true
+    },
+    category: {
+      type: 'string',
+      description:
+        'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
+      nullable: true,
+      example: 'DigitalWallet'
+    },
+    matchType: {
+      type: 'string',
+      description: "How this row matched: 'exact' > 'prefix' > 'substring'",
+      enum: ['exact', 'prefix', 'substring']
+    }
+  },
+  required: [
+    'id',
+    'name',
+    'canonical',
+    'type',
+    'suggestedSegment',
+    'logoUrl',
+    'countryCode',
+    'category',
+    'matchType'
+  ]
+} as const;
+
+export const $PlatformMatchResponseDto = {
+  type: 'object',
+  properties: {
+    platforms: {
+      description: 'Ranked matches, best tier first (at most 10 rows)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/PlatformMatchResultDto'
+      }
+    },
+    matchType: {
+      type: 'string',
+      description:
+        "Overall match quality — top row's tier, or 'none' when no hits",
+      enum: ['none', 'exact', 'prefix', 'substring']
+    },
+    total: {
+      type: 'number',
+      description: 'Total matches before LIMIT (truncation transparency)'
+    },
+    hasMore: {
+      type: 'boolean',
+      description: 'true when total > platforms.length (more matches exist)'
+    }
+  },
+  required: ['platforms', 'matchType', 'total', 'hasMore']
+} as const;
+
 export const $CreatePlatformDto = {
   type: 'object',
   properties: {
@@ -7561,292 +8561,378 @@ export const $HoldingPnlResponseDto = {
   required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
 } as const;
 
-export const $CurrencyBalanceDto = {
-  type: 'object',
-  properties: {
-    currency: {
-      type: 'string',
-      description: 'ISO 4217 currency code',
-      example: 'CNY'
-    },
-    balance: {
-      type: 'string',
-      description: 'Balance amount',
-      example: '500000.00'
-    }
-  },
-  required: ['currency', 'balance']
-} as const;
-
-export const $TimeSeriesPointDto = {
-  type: 'object',
-  properties: {
-    date: {
-      type: 'string',
-      description: 'Date in YYYY-MM-DD format',
-      example: '2024-06-15'
-    },
-    value: {
-      type: 'string',
-      description: 'Value at this date (in base currency)',
-      example: '500000.00'
-    },
-    change: {
-      type: 'object',
-      description: 'Change from previous point',
-      example: '5000.00'
-    },
-    assets: {
-      type: 'string',
-      description: 'Total assets at this date (in base currency)',
-      example: '494338.00'
-    },
-    liabilities: {
-      type: 'string',
-      description: 'Total liabilities at this date (in base currency)',
-      example: '310098.00'
-    },
-    byCurrency: {
-      description: 'Multi-currency breakdown for this point',
-      type: 'array',
-      items: {
-        $ref: '#/components/schemas/CurrencyBalanceDto'
-      }
-    }
-  },
-  required: ['date', 'value']
-} as const;
-
-export const $TrendSummaryDto = {
+export const $AnonymousLoginDto = {
   type: 'object',
   properties: {
-    startValue: {
-      type: 'string',
-      description: 'Value at start of period',
-      example: '450000.00'
-    },
-    endValue: {
-      type: 'string',
-      description: 'Value at end of period',
-      example: '500000.00'
-    },
-    totalChange: {
-      type: 'string',
-      description: 'Total change over period',
-      example: '50000.00'
-    },
-    totalChangePercentage: {
+    accessToken: {
       type: 'string',
-      description: 'Total change percentage',
-      example: '+11.11%'
+      description: 'Access token for anonymous login'
     }
   },
-  required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
+  required: ['accessToken']
 } as const;
 
-export const $MultiCurrencyPointDto = {
+export const $AnonymousLoginResponseDto = {
   type: 'object',
   properties: {
-    date: {
+    authToken: {
       type: 'string',
-      description: 'Date in YYYY-MM-DD format',
-      example: '2024-06-15'
-    },
-    byCurrency: {
-      description: 'Balances by currency',
-      type: 'array',
-      items: {
-        $ref: '#/components/schemas/CurrencyBalanceDto'
-      }
+      description: 'JWT auth token',
+      example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
     }
   },
-  required: ['date', 'byCurrency']
+  required: ['authToken']
 } as const;
 
-export const $PortfolioTrendsResponseDto = {
+export const $ParserContributionMetaDto = {
   type: 'object',
   properties: {
-    series: {
-      description: 'Time series data points',
-      type: 'array',
-      items: {
-        $ref: '#/components/schemas/TimeSeriesPointDto'
-      }
-    },
-    summary: {
-      description: 'Period summary',
-      allOf: [
-        {
-          $ref: '#/components/schemas/TrendSummaryDto'
-        }
+    institution: {
+      type: 'string',
+      description: 'Institution slug (lowercase kebab-case)',
+      pattern: '^[a-z0-9]+(-[a-z0-9]+)*$',
+      example: 'icbc'
+    },
+    region: {
+      type: 'string',
+      enum: [
+        'cn',
+        'us',
+        'de',
+        'fr',
+        'gb',
+        'hk',
+        'jp',
+        'sg',
+        'au',
+        'ca',
+        'other'
       ]
     },
-    period: {
+    accountType: {
       type: 'string',
-      description: 'Period requested',
-      example: '6m'
+      enum: ['checking', 'savings', 'credit', 'debit', 'investment']
     },
-    granularity: {
+    format: {
       type: 'string',
-      description: 'Data granularity',
-      example: 'month'
+      enum: ['csv', 'xlsx', 'pdf', 'ofx', 'qif']
     },
-    currency: {
+    institutionDisplayName: {
       type: 'string',
-      description: 'Base currency for converted values',
-      example: 'CNY'
+      example: '中国工商银行'
     },
-    byCurrency: {
+    encoding: {
+      type: 'string',
+      example: 'utf-8'
+    },
+    delimiter: {
+      type: 'string',
+      description: 'CSV delimiter character: ",", ";", "\\t" or "|"'
+    },
+    headerRows: {
+      type: 'number',
+      default: 1,
+      description: 'Header row count; the client omits the field when it is 1'
+    },
+    notes: {
+      type: 'string',
+      maxLength: 2000
+    }
+  },
+  required: ['institution', 'region', 'accountType', 'format']
+} as const;
+
+export const $ParserContributionSamplesDto = {
+  type: 'object',
+  properties: {
+    rows: {
       description:
-        'Multi-currency time series (each point has currency breakdown)',
+        'Client-sanitized sample rows (key = column name, value = cell)',
       type: 'array',
       items: {
-        $ref: '#/components/schemas/MultiCurrencyPointDto'
+        type: 'object'
       }
     },
-    warnings: {
-      description: 'Exchange rate warnings',
+    rawHeaders: {
       type: 'array',
       items: {
-        $ref: '#/components/schemas/ExchangeRateWarningDto'
+        type: 'string'
       }
     }
   },
-  required: ['series', 'summary', 'period', 'granularity', 'currency']
+  required: ['rows']
 } as const;
 
-export const $CashFlowPointDto = {
+export const $FieldHintDto = {
   type: 'object',
   properties: {
-    month: {
+    columnName: {
       type: 'string',
-      description: 'Month key (YYYY-MM)',
-      example: '2024-03'
+      example: '交易日期'
     },
-    income: {
+    format: {
       type: 'string',
-      description: 'Income in base currency (absolute, converted)',
-      example: '10000.00'
+      description: 'Date format, e.g. yyyy-MM-dd HH:mm',
+      example: 'yyyy-MM-dd'
     },
-    expense: {
+    signConvention: {
       type: 'string',
-      description: 'Expense in base currency (absolute, converted)',
-      example: '5000.00'
+      enum: ['negative-expense', 'positive-expense', 'separate-columns']
     },
-    netSavings: {
-      type: 'string',
-      description: 'netSavings = income − expense (savings positive)',
-      example: '5000.00'
+    creditColumn: {
+      type: 'string'
+    },
+    debitColumn: {
+      type: 'string'
     }
   },
-  required: ['month', 'income', 'expense', 'netSavings']
+  required: ['columnName']
 } as const;
 
-export const $CashFlowTrendSummaryDto = {
+export const $ParserContributionFieldHintsDto = {
   type: 'object',
   properties: {
-    totalIncome: {
-      type: 'string',
-      description: 'Total income across the period',
-      example: '60000.00'
+    date: {
+      $ref: '#/components/schemas/FieldHintDto'
     },
-    totalExpense: {
-      type: 'string',
-      description: 'Total expense across the period',
-      example: '30000.00'
+    amount: {
+      $ref: '#/components/schemas/FieldHintDto'
     },
-    totalNetSavings: {
-      type: 'string',
-      description: 'income − expense across the period',
-      example: '30000.00'
+    description: {
+      $ref: '#/components/schemas/FieldHintDto'
     },
-    averageMonthlyNetSavings: {
-      type: 'string',
-      description:
-        'totalNetSavings divided by the window length (N months, incl. zero-filled)',
-      example: '5000.00'
+    balance: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    payee: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    reference: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    category: {
+      $ref: '#/components/schemas/FieldHintDto'
     }
   },
-  required: [
-    'totalIncome',
-    'totalExpense',
-    'totalNetSavings',
-    'averageMonthlyNetSavings'
-  ]
+  required: ['date', 'amount']
 } as const;
 
-export const $CashFlowTrendsResponseDto = {
+export const $ExpectedTransactionDto = {
   type: 'object',
   properties: {
-    series: {
-      description:
-        'Monthly cash-flow series (fixed N-month window, zero-filled)',
-      type: 'array',
-      items: {
-        $ref: '#/components/schemas/CashFlowPointDto'
-      }
-    },
-    summary: {
-      description: 'Period totals',
-      allOf: [
-        {
-          $ref: '#/components/schemas/CashFlowTrendSummaryDto'
-        }
-      ]
-    },
-    period: {
+    date: {
       type: 'string',
-      description: 'Period requested',
-      example: '6m'
+      example: '2026-08-01'
     },
-    granularity: {
-      type: 'string',
-      description: 'Data granularity (v1 returns month buckets)',
-      example: 'month'
+    amount: {
+      type: 'number',
+      example: -45.5
     },
-    currency: {
+    description: {
       type: 'string',
-      description: 'Base currency for converted values',
-      example: 'CNY'
+      example: '星巴克-***店'
     },
-    warnings: {
-      description: 'Exchange rate warnings (e.g. missing rate for a currency)',
-      type: 'array',
-      items: {
-        $ref: '#/components/schemas/ExchangeRateWarningDto'
-      }
+    payee: {
+      type: 'string'
+    },
+    category: {
+      type: 'string'
     }
   },
-  required: ['series', 'summary', 'period', 'granularity', 'currency']
+  required: ['date', 'amount', 'description']
 } as const;
 
-export const $GenerateSnapshotBody = {
+export const $ParserContributionExamplesDto = {
   type: 'object',
-  properties: {}
+  properties: {
+    expectedTransactions: {
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExpectedTransactionDto'
+      }
+    }
+  },
+  required: ['expectedTransactions']
 } as const;
 
-export const $GenerateSnapshotResponse = {
+export const $ParserContributionRequestDto = {
   type: 'object',
-  properties: {}
+  properties: {
+    meta: {
+      $ref: '#/components/schemas/ParserContributionMetaDto'
+    },
+    samples: {
+      $ref: '#/components/schemas/ParserContributionSamplesDto'
+    },
+    fieldHints: {
+      $ref: '#/components/schemas/ParserContributionFieldHintsDto'
+    },
+    examples: {
+      description: 'Omitted entirely by the client when empty',
+      allOf: [
+        {
+          $ref: '#/components/schemas/ParserContributionExamplesDto'
+        }
+      ]
+    }
+  },
+  required: ['meta', 'samples', 'fieldHints']
 } as const;
 
-export const $BackfillSnapshotsBody = {
+export const $ParserContributionRelayResponseDto = {
   type: 'object',
-  properties: {}
+  properties: {
+    issueUrl: {
+      type: 'string',
+      example: 'https://github.com/fire-zu/firela-vlt/issues/42'
+    },
+    issueNumber: {
+      type: 'number',
+      example: 42
+    }
+  },
+  required: ['issueUrl', 'issueNumber']
 } as const;
 
-export const $BackfillSnapshotsResponse = {
+export const $SymbolSearchResultDto = {
   type: 'object',
-  properties: {}
+  properties: {
+    symbol: {
+      type: 'string',
+      example: 'AAPL'
+    },
+    name: {
+      type: 'object',
+      example: 'Apple Inc.',
+      nullable: true
+    },
+    exchange: {
+      type: 'object',
+      example: 'US',
+      nullable: true
+    },
+    assetType: {
+      type: 'object',
+      description: 'OpenBB asset_type (e.g. stock, etf)',
+      example: 'stock',
+      nullable: true
+    },
+    assetClass: {
+      type: 'object',
+      description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
+      example: 'EQUITY',
+      nullable: true
+    },
+    assetSubClass: {
+      type: 'object',
+      description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
+      example: 'STOCK',
+      nullable: true
+    },
+    currency: {
+      type: 'object',
+      description: 'Trading currency (extra_data or inferred from exchange)',
+      example: 'USD',
+      nullable: true
+    }
+  },
+  required: ['symbol']
 } as const;
 
-export const $AnonymousLoginDto = {
+export const $SymbolQuoteDto = {
   type: 'object',
   properties: {
-    accessToken: {
+    symbol: {
       type: 'string',
-      description: 'Access token for anonymous login'
+      example: 'AAPL'
+    },
+    name: {
+      type: 'object',
+      example: 'Apple Inc.',
+      nullable: true
+    },
+    exchange: {
+      type: 'object',
+      example: 'US',
+      nullable: true
+    },
+    assetType: {
+      type: 'object',
+      description: 'OpenBB asset_type',
+      example: 'stock',
+      nullable: true
+    },
+    assetClass: {
+      type: 'object',
+      description: 'IGN asset class',
+      example: 'EQUITY',
+      nullable: true
+    },
+    assetSubClass: {
+      type: 'object',
+      description: 'IGN asset sub-class',
+      example: 'STOCK',
+      nullable: true
+    },
+    currency: {
+      type: 'object',
+      description: 'Trading currency (extra_data or inferred from exchange)',
+      example: 'USD',
+      nullable: true
+    },
+    price: {
+      type: 'object',
+      description: 'Latest price (Decimal string)',
+      example: '189.84',
+      nullable: true
+    },
+    priceDate: {
+      type: 'object',
+      description: 'Date the price was observed (ISO yyyy-MM-dd)',
+      example: '2026-08-05',
+      nullable: true
+    },
+    changePercent: {
+      type: 'object',
+      description:
+        '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.',
+      example: 1.7,
+      nullable: true
+    },
+    prevClose: {
+      type: 'object',
+      description: 'Previous close (Decimal string)',
+      nullable: true
+    },
+    open: {
+      type: 'object',
+      description: 'Day open (Decimal string)',
+      nullable: true
+    },
+    high: {
+      type: 'object',
+      description: 'Day high (Decimal string)',
+      nullable: true
+    },
+    low: {
+      type: 'object',
+      description: 'Day low (Decimal string)',
+      nullable: true
+    },
+    volume: {
+      type: 'object',
+      description: 'Day volume (Decimal string)',
+      nullable: true
+    },
+    yearHigh: {
+      type: 'object',
+      description: '52-week high (Decimal string)',
+      nullable: true
+    },
+    yearLow: {
+      type: 'object',
+      description: '52-week low (Decimal string)',
+      nullable: true
     }
-  },
-  required: ['accessToken']
+  }
 } as const;