@lunch-money/developer-docs 2.11.0-preview.16 → 2.11.0-preview.17

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunch-money/developer-docs",
-  "version": "2.11.0-preview.16",
+  "version": "2.11.0-preview.17",
   "description": "Developer documentation content for Lunch Money APIs",
   "exports": {
     ".": "./package.json",

package/v2/spec/lunch-money-api-v2.yaml

@@ -2,10 +2,10 @@ openapi: 3.0.2
 info:
   title: Lunch Money API - v2
   description: |-
-    Welcome to the Lunch Money v2 API reference. This is the **v2.11.0** spec.
-
     ### Introduction
 
+    Welcome to the Lunch Money v2 API reference. This is the **v2.11.0** spec.
+
     The API is available at `https://api.lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
 
     
@@ -79,7 +79,11 @@ tags:
       description: Learn more about crypto assets
       url: https://support.lunchmoney.app/setup/crypto
   - name: balance_history
-    description: View and update historical account balances. Balance history is what drives the [Net Worth](https://my.lunchmoney.app/net-worth) views in the Lunch Money app. Balance history is generated for each account's balance on the first day of each month and can be edited in the Lunch Money app or via the API.
+    description: >-
+      View and update monthly account balances used by the
+      [Net Worth](https://my.lunchmoney.app/net-worth) views in the Lunch Money app.
+      History is monthly. The current month may be calculated on demand when
+      requested.
   - name: recurring_items
     description: Work with recurring items
     externalDocs:
@@ -1643,7 +1647,7 @@ components:
         type:
           type: string
           enum: [manual]
-          description: Identifies this entry as belonging to a manually-managed account.
+          description: Identifies this entry as belonging to a manual account.
         manual_account_id:
           type: integer
           format: int32
@@ -1672,14 +1676,14 @@ components:
 
     balanceHistorySourceCryptoManual:
       type: object
-      description: Source information for a manually-tracked cryptocurrency balance history entry.
+      description: Source information for a manual cryptocurrency balance history entry.
       additionalProperties: false
       x-internal: true
       properties:
         type:
           type: string
           enum: [crypto_manual]
-          description: Identifies this entry as belonging to a manually-tracked crypto account.
+          description: Identifies this entry as belonging to a manual crypto account.
         crypto_manual_id:
           type: integer
           format: int32
@@ -1722,10 +1726,11 @@ components:
       type: object
       x-internal: true
       description: >
-        Source information for a balance history entry whose account has since been deleted.
+        Source information for balance history whose account has since been deleted.
         Historical balances are preserved when a user chooses to keep history on account deletion.
         This object contains details that can be used to display the deleted account in the UI.
-        The `deleted_account_id` can be passed to `PUT /v2/balance_history/deleted/{account_id}/details`
+        The `deleted_account_id` can be passed to
+        [PUT /balance_history/deleted/{account_id}/details](#tag/balance-history/PUT/balance_history/deleted/{account_id}/details)
         to update the archived source metadata.
       additionalProperties: false
       properties:
@@ -1756,11 +1761,11 @@ components:
         subtype:
           type: string
           nullable: true
-          description: Archived `subtype`` of the deleted account source
+          description: Archived `subtype` of the deleted account source
         mask:
           type: string
           nullable: true
-          description: Archived account `mask` for a deleted plaid account source
+          description: Archived account `mask` for a deleted Plaid account source
         symbol:
           type: string
           nullable: true
@@ -1782,12 +1787,14 @@ components:
       type: object
       title: balance history for an account object
       additionalProperties: false
-      description: Historical balance entries grouped under a single account source.
+      description: Monthly balance entries grouped under a single account source.
       properties:
         source:
           description: >
-            Identifies the account this balance entry belongs to. The shape varies by
-            `source.type`. Use `source.type` to determine which account id field is present.
+            Identifies the account these balance entries belong to. The shape varies by
+            `source.type`. Each source type exposes a type-specific account id field
+            (`manual_account_id`, `plaid_account_id`, `crypto_manual_id`,
+            `crypto_synced_id`, or `deleted_account_id`).
           oneOf:
             - $ref: "#/components/schemas/balanceHistorySourceManual"
             - $ref: "#/components/schemas/balanceHistorySourcePlaid"
@@ -1805,38 +1812,48 @@ components:
         balances:
           type: array
           description: >
-            Monthly balance history entries for the source account. On GET responses,
-            this includes all entries in the requested range. On PUT upsert responses,
-            this includes only the entries modified by that request.
+            Monthly balance entries for this account source. A `historical` entry is
+            a stored snapshot of a past month and includes an `id`. A `current` entry
+            is an ephemeral snapshot based on the account's current balances and has
+            no balance-entry `id`. On PUT upsert responses, this array includes only
+            the `type: historical` entries modified by that request.
           items:
-            $ref: "#/components/schemas/balanceHistoryObject"
+            $ref: "#/components/schemas/balanceHistoryEntry"
       required:
         - source
         - balances
 
-    balanceHistoryObject:
+    historicalBalanceHistoryEntry:
       type: object
-      title: balance history entry object
+      title: historical balance history entry
       additionalProperties: false
       x-internal: true
-      description: A historical balance entry for a single account on a single date.
+      description: >
+        A stored monthly balance for a past month. The `id` may be used with
+        balance history entry endpoints. The balance represents the account
+        balance at or around the end of `month`.
       properties:
+        type:
+          type: string
+          enum: [historical]
+          description: Identifies this entry as a stored snapshot of a past month.
         id:
           type: integer
           format: int32
-          description: Unique identifier of this historical balance entry.
-        date:
+          description: Unique identifier for this historical balance entry.
+        month:
           type: string
-          format: date
-          description: Date of this historical balance entry in YYYY-MM-DD format. This is always the first day of a month.
+          pattern: '^\d{4}-(0[1-9]|1[0-2])$'
+          description: Calendar month for this entry in YYYY-MM format.
+          example: "2026-06"
         balance:
           type: string
           pattern: ^-?\d+(\.\d{1,4})?$
-          description: Historical balance stored for this entry, as a numeric string with up to four decimal places. Trailing zeros and decimal places are not guaranteed in responses. For manual and Plaid accounts this is in the account currency. For crypto accounts this is in the user's primary currency.
+          description: Historical balance for this entry, as a numeric string with up to four decimal places. Trailing zeros and decimal places are not guaranteed in responses. For manual and Plaid accounts this is in the account currency. For crypto accounts this is in the user's primary currency.
         currency:
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
-          description: Currency of the stored `balance`. For crypto entries this is the user's primary currency.
+          description: Currency of `balance`. For crypto entries this is the user's primary currency.
         to_base:
           type: number
           format: double
@@ -1845,19 +1862,82 @@ components:
           type: string
           nullable: true
           pattern: ^-?\d+(\.\d{1,18})?$
-          description: Crypto quantity stored for this balance entry, when available. This may be present for crypto or deleted-account entries and is `null` otherwise.
+          description: Crypto quantity for this balance entry, when available. This may be present for crypto or deleted-account entries and is `null` otherwise.
       required:
+        - type
         - id
-        - date
+        - month
+        - balance
+        - currency
+        - to_base
+        - crypto_balance
+
+    currentBalanceHistoryEntry:
+      type: object
+      title: current balance history entry
+      additionalProperties: false
+      x-internal: true
+      description: >
+        An ephemeral snapshot based on the account's current balances. It may
+        change between requests.
+      properties:
+        type:
+          type: string
+          enum: [current]
+          description: Identifies this entry as an ephemeral current-month snapshot.
+        month:
+          type: string
+          pattern: '^\d{4}-(0[1-9]|1[0-2])$'
+          description: Calendar month for this entry in YYYY-MM format. For current entries this is the current month.
+          example: "2026-07"
+        balance:
+          type: string
+          pattern: ^-?\d+(\.\d{1,4})?$
+          description: Calculated balance for the current month, as a numeric string with up to four decimal places. Trailing zeros and decimal places are not guaranteed in responses. For manual and Plaid accounts this is in the account currency. For crypto accounts this is in the user's primary currency.
+        currency:
+          allOf:
+            - $ref: "#/components/schemas/currencyEnum"
+          description: Currency of the calculated `balance`. For crypto entries this is the user's primary currency.
+        to_base:
+          type: number
+          format: double
+          description: Calculated balance converted to the user's primary currency. When the entry currency is the user's primary currency, this is the numeric value of `balance`.
+        crypto_balance:
+          type: string
+          nullable: true
+          pattern: ^-?\d+(\.\d{1,18})?$
+          description: Crypto quantity for this calculated entry, when available. This may be present for crypto entries and is `null` otherwise.
+      required:
+        - type
+        - month
         - balance
         - currency
         - to_base
         - crypto_balance
 
+    balanceHistoryEntry:
+      title: balance history entry
+      x-internal: true
+      description: >
+        A monthly balance history entry. Discriminated by `type`. `historical`
+        entries are stored snapshots of past months with an `id`. `current`
+        entries are ephemeral snapshots with no balance-entry `id`.
+      oneOf:
+        - $ref: "#/components/schemas/historicalBalanceHistoryEntry"
+        - $ref: "#/components/schemas/currentBalanceHistoryEntry"
+      discriminator:
+        propertyName: type
+        mapping:
+          historical: "#/components/schemas/historicalBalanceHistoryEntry"
+          current: "#/components/schemas/currentBalanceHistoryEntry"
+
     balanceHistoryListResponseObject:
       type: object
       additionalProperties: false
       x-internal: true
+      description: >
+        List response for balance history GET endpoints. Entries are grouped by
+        account source under `balance_history`.
       properties:
         balance_history:
           type: array
@@ -1870,31 +1950,39 @@ components:
       type: object
       x-internal: true
       additionalProperties: false
+      description: >
+        A single monthly balance entry to upsert. Request bodies use this shape.
+        Responses return `type: historical` entries instead.
       properties:
         id:
           type: integer
           format: int32
           description: System-defined balance history entry id. Ignored if set.
           x-updatable: false
-        date:
+        month:
           type: string
-          format: date
-          description: Month to update, in YYYY-MM-DD format. This must be the first day of a month and must be in a past month.
+          pattern: '^\d{4}-(0[1-9]|1[0-2])$'
+          description: >
+            Calendar month to upsert, in YYYY-MM format. Must be a past month.
+            The current month cannot be written through PUT endpoints.
+          example: "2026-06"
         balance:
           oneOf:
             - type: number
               format: double
             - type: string
               pattern: ^-?\d+(\.\d{1,4})?$
-          description: Numeric value of the historical balance, up to four decimal places, as a number or string. For manual and Plaid accounts this is typically in the account currency. For crypto and deleted accounts this is typically in the user's primary currency. Do not include any special characters aside from a decimal point.
+          description: Numeric value of the historical balance, up to four decimal places, as a number or string. For manual and Plaid accounts this is in the account currency. For crypto and deleted accounts this is in the user's primary currency. Do not include any special characters aside from a decimal point.
         symbol:
           type: string
           nullable: true
           minLength: 1
           maxLength: 25
-          description: Optional for crypto balances, but if set it must match the account's symbol.
-            Tolerated for deleted-account balances. Do not provide this for manual or Plaid balances.
-            If provided when using the synced crypto path-based endpoint, this must match the symbol in the path.
+          description: >
+            Optional for crypto balances. If set, it must match the account's
+            symbol. Tolerated for deleted-account balances. Do not provide this
+            for manual or Plaid balances. On the synced crypto path endpoint, if
+            provided it must match the `symbol` path parameter.
           x-updatable: true
         crypto_balance:
           type: string
@@ -1910,10 +1998,10 @@ components:
         to_base:
           type: number
           format: double
-          description: System-defined historical balance converted to the user's primary currency. Ignored if set. Use `balance` to update the stored historical balance.
+          description: System-defined historical balance converted to the user's primary currency. Ignored if set. Use `balance` to update the historical balance.
           x-updatable: false
       required:
-        - date
+        - month
         - balance
 
     upsertBalanceHistoryRequestObject:
@@ -1924,7 +2012,11 @@ components:
         balances:
           type: array
           minItems: 1
-          description: One or more monthly balance history entries to upsert
+          description: >
+            One or more monthly balance history entries to upsert. Each entry uses
+            `month` (YYYY-MM) and `balance`. Do not include response-only fields such
+            as `type`. PUT responses return only the `type: historical` entries
+            modified by the request.
           items:
             $ref: "#/components/schemas/balanceHistoryUpdateItemObject"
       required:
@@ -1939,51 +2031,58 @@ components:
         name:
           type: string
           nullable: true
-          description: New archived account name for the deleted account source.
+          description: New archived account name for the deleted account source
         institution_name:
           type: string
           nullable: true
-          description: New archived institution name for the deleted account source.
+          description: New archived institution name for the deleted account source
         display_name:
           type: string
           nullable: true
-          description: New display name for the deleted account source.
+          description: New display name for the deleted account source
         account_type:
           type: string
           nullable: true
-          description: New archived account type for the deleted account source.
+          description: New archived account type for the deleted account source
         subtype:
           type: string
           nullable: true
-          description: New archived subtype for the deleted account source.
+          description: New archived subtype for the deleted account source
         mask:
           type: string
           nullable: true
-          description: New archived account mask for the deleted account source.
+          description: New archived account mask for the deleted account source
 
     updateBalanceHistoryDetailsResponseObject:
       type: object
       x-internal: true
       additionalProperties: false
+      description: Updated archived metadata for a deleted balance history source
       properties:
         name:
           type: string
           nullable: true
+          description: Archived account name for the deleted account source
         institution_name:
           type: string
           nullable: true
+          description: Archived institution name for the deleted account source
         display_name:
           type: string
           nullable: true
+          description: Archived display name for the deleted account source
         account_type:
           type: string
           nullable: true
+          description: Archived account type for the deleted account source
         subtype:
           type: string
           nullable: true
+          description: Archived subtype for the deleted account source
         mask:
           type: string
           nullable: true
+          description: Archived account mask for the deleted account source
       required:
         - name
         - institution_name
@@ -6505,37 +6604,54 @@ paths:
         - balance_history
       summary: Get balance history
       description: |-
-        Retrieve historical balance entries.<br><br>
-        Balance history is monthly. When `start_date` and `end_date` are both provided, they must be first-of-month dates. `start_date` must not be in the future, while `end_date` may be in the future. If one of `start_date` or `end_date` is provided, the other is required. If neither is provided, all available balance history is returned.<br><br>
-        The response groups entries by source account. Each item in `balance_history` contains a `source` object plus a `balances` array containing one balance entry per month in the requested range, or all stored entries when no range is provided.<br><br>
-        Historical entries for accounts that have been deleted may still be returned. These entries use `source.type: deleted` and include `deleted_account_id`, archived display fields, and account metadata on the `source` object.
+        Retrieve monthly balance history for all account sources.<br><br>
+        Balance history is monthly. Each entry represents the account balance at or around the end of the specified month. System-generated entries are generally captured near the boundary between months.<br><br>
+        Query with optional `start_month` and `end_month` in YYYY-MM format. The range is inclusive. If either parameter is provided, both are required. `start_month` must not be in the future. `end_month` may not be earlier than `start_month` and must not be in the future. Values must be valid calendar months in exact YYYY-MM format. A full date such as `2026-06-01` is invalid. If neither is provided, all available balance history is returned, including an ephemeral `current` entry for the current month when applicable.<br><br>
+        The response groups entries by source account. Each item in `balance_history` contains a `source` object plus a `balances` array. Within a requested range (or across all history when no range is provided), the array includes only months that have data — months with no data are omitted. A `current` entry is also included when the requested range includes the current month.<br><br>
+        Each balance entry has a `type`:<br>
+        - `historical`: stored snapshot of a past month for an active or deleted account. Includes an `id` that can be used with balance history entry endpoints<br>
+        - `current`: snapshot based on the account's current balances. It is ephemeral and may change between requests. To inspect the underlying account, use the type-specific source id for the `source.type` values:<br>
+        &nbsp;&nbsp;&nbsp;&nbsp;- `manual`: `source.manual_account_id` with [GET /manual_accounts/{id}](#tag/manual-accounts/GET/manual_accounts/{id})<br>
+        &nbsp;&nbsp;&nbsp;&nbsp;- `plaid`: `source.plaid_account_id` with [GET /plaid_accounts/{id}](#tag/plaid-accounts/GET/plaid_accounts/{id})<br>
+        &nbsp;&nbsp;&nbsp;&nbsp;- `crypto_manual`: `source.crypto_manual_id` with [GET /crypto/manual/{id}](#tag/crypto-manual/GET/crypto/manual/{id})<br>
+        &nbsp;&nbsp;&nbsp;&nbsp;- `crypto_synced`: `source.crypto_synced_id` and `source.symbol` with [GET /crypto/synced/{id}/{symbol}](#tag/crypto-synced/GET/crypto/synced/{id}/{symbol})
       operationId: getBalanceHistory
       parameters:
-        - name: start_date
+        - name: start_month
           in: query
-          description: Optional start date for the requested history range in YYYY-MM-DD format. If set, `end_date` is also required. This must be the first day of a month and must not be in the future.
+          description: >-
+            Optional start of the requested history range as a calendar month in
+            YYYY-MM format (for example `2026-06`). If set, `end_month` is also
+            required. The range is inclusive. `start_month` must not be in the
+            future. A full date such as `2026-06-01` is invalid.
           required: false
           schema:
             type: string
-            format: date
+            pattern: '^\d{4}-(0[1-9]|1[0-2])$'
           examples:
             range start:
-              summary: Start date
-              value: "2026-01-01"
-        - name: end_date
+              summary: Start month
+              value: "2026-01"
+        - name: end_month
           in: query
-          description: Optional end date for the requested history range in YYYY-MM-DD format. If set, `start_date` is also required. This must be the first day of a month. For a single month, set this to the same first-of-month date as `start_date`.
+          description: >-
+            Optional end of the requested history range as a calendar month in
+            YYYY-MM format (for example `2026-06`). If set, `start_month` is also
+            required. The range is inclusive. `end_month` may not be earlier than
+            `start_month` and must not be in the future. A full date such as
+            `2026-06-01` is invalid. For a single month, set this to the same
+            value as `start_month`.
           required: false
           schema:
             type: string
-            format: date
+            pattern: '^\d{4}-(0[1-9]|1[0-2])$'
           examples:
             range end:
-              summary: End date
-              value: "2026-03-01"
+              summary: End month
+              value: "2026-03"
       responses:
         "200":
-          description: Historical balance entries for the requested date range
+          description: Monthly balance history for the requested month range
           content:
             application/json:
               schema:
@@ -6548,14 +6664,16 @@ paths:
                           type: manual
                           manual_account_id: 119807
                         balances:
-                          - id: 101
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 101
+                            month: "2026-01"
                             balance: "41000.0000"
                             currency: usd
                             to_base: 41000
                             crypto_balance: null
-                          - id: 102
-                            date: "2026-02-01"
+                          - type: historical
+                            id: 102
+                            month: "2026-02"
                             balance: "41211.8000"
                             currency: usd
                             to_base: 41211.8
@@ -6564,8 +6682,9 @@ paths:
                           type: plaid
                           plaid_account_id: 119808
                         balances:
-                          - id: 103
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 103
+                            month: "2026-01"
                             balance: "5498.2800"
                             currency: usd
                             to_base: 5498.28
@@ -6575,8 +6694,9 @@ paths:
                           crypto_manual_id: 22001
                           symbol: btc
                         balances:
-                          - id: 104
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 104
+                            month: "2026-01"
                             balance: "53124.7200"
                             currency: usd
                             to_base: 53124.72
@@ -6586,8 +6706,9 @@ paths:
                           crypto_synced_id: 33004
                           symbol: btc
                         balances:
-                          - id: 105
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 105
+                            month: "2026-01"
                             balance: "6231.2800"
                             currency: usd
                             to_base: 6231.28
@@ -6603,12 +6724,34 @@ paths:
                           mask: "1234"
                           symbol: null
                         balances:
-                          - id: 106
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 106
+                            month: "2026-01"
                             balance: "1250.0000"
                             currency: usd
                             to_base: 1250
                             crypto_balance: null
+                historical and current:
+                  summary: Historical month plus ephemeral current month
+                  value:
+                    balance_history:
+                      - source:
+                          type: manual
+                          manual_account_id: 162003
+                        balances:
+                          - type: historical
+                            id: 7437356
+                            month: "2026-06"
+                            balance: "62.8"
+                            currency: usd
+                            to_base: 62.8
+                            crypto_balance: null
+                          - type: current
+                            month: "2026-07"
+                            balance: "71.2"
+                            currency: usd
+                            to_base: 71.2
+                            crypto_balance: null
                 manual account history:
                   value:
                     balance_history:
@@ -6616,14 +6759,16 @@ paths:
                           type: manual
                           manual_account_id: 119807
                         balances:
-                          - id: 201
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 201
+                            month: "2026-01"
                             balance: "41000.0000"
                             currency: usd
                             to_base: 41000
                             crypto_balance: null
-                          - id: 202
-                            date: "2026-02-01"
+                          - type: historical
+                            id: 202
+                            month: "2026-02"
                             balance: "41211.8000"
                             currency: usd
                             to_base: 41211.8
@@ -6635,8 +6780,9 @@ paths:
                           type: plaid
                           plaid_account_id: 119808
                         balances:
-                          - id: 301
-                            date: "2026-02-01"
+                          - type: historical
+                            id: 301
+                            month: "2026-02"
                             balance: "5498.2800"
                             currency: usd
                             to_base: 5498.28
@@ -6649,8 +6795,9 @@ paths:
                           crypto_synced_id: 33004
                           symbol: btc
                         balances:
-                          - id: 401
-                            date: "2026-02-01"
+                          - type: historical
+                            id: 401
+                            month: "2026-02"
                             balance: "6231.2800"
                             currency: usd
                             to_base: 6231.28
@@ -6669,8 +6816,9 @@ paths:
                           mask: "1234"
                           symbol: null
                         balances:
-                          - id: 501
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 501
+                            month: "2026-01"
                             balance: "1250.0000"
                             currency: usd
                             to_base: 1250
@@ -6682,26 +6830,31 @@ paths:
               schema:
                 $ref: "#/components/schemas/errorResponseObject"
               examples:
-                missing paired date:
+                missing paired month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`start_date` and `end_date` must either both be provided or both be omitted."
+                      - errMsg: "`start_month` and `end_month` must either both be provided or both be omitted."
                 invalid range:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`start_date` must be before or equal to `end_date`."
-                not first of month:
+                      - errMsg: "`end_month` may not be earlier than `start_month`."
+                invalid month format:
+                  value:
+                    message: Invalid Request Parameters
+                    errors:
+                      - errMsg: "Invalid value for parameter: 'start_month'. '2026-06-01' is not a valid month in YYYY-MM format."
+                future start month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`start_date` and `end_date` must both be the first day of a month."
-                future start date:
+                      - errMsg: "`start_month` must not be in the future."
+                future end month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`start_date` must not be in the future."
+                      - errMsg: "`end_month` must not be in the future."
         "401":
           $ref: "#/components/responses/unauthorizedToken"
         "429":
@@ -6714,15 +6867,15 @@ paths:
         - balance_history
       summary: Get balance history for an account
       description: |-
-        Retrieve historical balance entries for one manual, Plaid, manual crypto, or deleted account.  Crypto synced accounts require an additional `symbol` path parameter.<br><br>
-        The `account_type` path parameter identifies the type of account and the `account_id` path parameter identifies the specific id for that account type.<br><br>
-        When `start_date` and `end_date` are both provided, they must be first-of-month dates. `start_date` must not be in the future, while `end_date` may be in the future. If one of `start_date` or `end_date` is provided, the other is required. If neither is provided, all available history for the source is returned.
+        Retrieve monthly balance history for one manual, Plaid, manual crypto, or deleted account. For synced crypto symbol streams, use [GET /balance_history/crypto_synced/{account_id}/{symbol}](#tag/balance-history/GET/balance_history/crypto_synced/{account_id}/{symbol}).<br><br>
+        The `account_type` path parameter identifies the account family (`manual`, `plaid`, `crypto_manual`, or `deleted`) and `account_id` identifies the account within that family.<br><br>
+        `start_month`, `end_month`, and current-month entries behave as described in [GET /balance_history](#tag/balance-history/GET/balance_history).
       operationId: getBalanceHistoryForAccount
       parameters:
         - name: account_type
           in: path
           required: true
-          description: Source family to retrieve. Use `manual`, `plaid`, `crypto_manual`, or `deleted`.
+          description: Account family to retrieve. Use `manual`, `plaid`, `crypto_manual`, or `deleted`.
           schema:
             type: string
             enum: [manual, plaid, crypto_manual, deleted]
@@ -6733,23 +6886,27 @@ paths:
           schema:
             type: integer
             format: int32
-        - name: start_date
+        - name: start_month
           in: query
-          description: Optional start date for the requested history range in YYYY-MM-DD format. If set, `end_date` is also required. This must be the first day of a month and must not be in the future.
+          description: >-
+            Optional. Same format and constraints as `start_month` on
+            [GET /balance_history](#tag/balance-history/GET/balance_history).
           required: false
           schema:
             type: string
-            format: date
-        - name: end_date
+            pattern: '^\d{4}-(0[1-9]|1[0-2])$'
+        - name: end_month
           in: query
-          description: Optional end date for the requested history range in YYYY-MM-DD format. If set, `start_date` is also required. This must be the first day of a month.
+          description: >-
+            Optional. Same format and constraints as `end_month` on
+            [GET /balance_history](#tag/balance-history/GET/balance_history).
           required: false
           schema:
             type: string
-            format: date
+            pattern: '^\d{4}-(0[1-9]|1[0-2])$'
       responses:
         "200":
-          description: Historical balance entries for the requested source
+          description: Monthly balance history for the requested source
           content:
             application/json:
               schema:
@@ -6762,14 +6919,16 @@ paths:
                           type: manual
                           manual_account_id: 119807
                         balances:
-                          - id: 201
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 201
+                            month: "2026-01"
                             balance: "41000.0000"
                             currency: usd
                             to_base: 41000
                             crypto_balance: null
-                          - id: 202
-                            date: "2026-02-01"
+                          - type: historical
+                            id: 202
+                            month: "2026-02"
                             balance: "41211.8000"
                             currency: usd
                             to_base: 41211.8
@@ -6788,8 +6947,9 @@ paths:
                           mask: "1234"
                           symbol: null
                         balances:
-                          - id: 501
-                            date: "2026-01-01"
+                          - type: historical
+                            id: 501
+                            month: "2026-01"
                             balance: "1250.0000"
                             currency: usd
                             to_base: 1250
@@ -6801,16 +6961,16 @@ paths:
               schema:
                 $ref: "#/components/schemas/errorResponseObject"
               examples:
-                missing paired date:
+                missing paired month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`start_date` and `end_date` must either both be provided or both be omitted."
-                invalid range:
+                      - errMsg: "`start_month` and `end_month` must either both be provided or both be omitted."
+                invalid month format:
                   value:
-                    message: Request Validation Failure
+                    message: Invalid Request Parameters
                     errors:
-                      - errMsg: "`start_date` must be before or equal to `end_date`."
+                      - errMsg: "Invalid value for parameter: 'start_month'. '2026-06-01' is not a valid month in YYYY-MM format."
         "401":
           $ref: "#/components/responses/unauthorizedToken"
         "404":
@@ -6839,20 +6999,19 @@ paths:
         - balance_history
       summary: Upsert balance history for an account
       description: |-
-        Upsert one or more historical balance entries for a single manual, Plaid, manual crypto, or deleted account. Crypto synced accounts require an additional `symbol` path parameter.<br><br>
-        The `account_type` path parameter identifies the type of account and the `account_id` path parameter identifies the specific id for that account type.<br><br>
-        Submit one or more entries in the `balances` array. Each entry must specify a `date` and `balance` value.<br><br>
-        Balance history is monthly. Each entry's `date` must be the first day of a month and must be in a past month.<br><br>
+        Upsert one or more historical balance entries for a single manual, Plaid, manual crypto, or deleted account. For synced crypto symbol streams, use [PUT /balance_history/crypto_synced/{account_id}/{symbol}](#tag/balance-history/PUT/balance_history/crypto_synced/{account_id}/{symbol}).<br><br>
+        The `account_type` path parameter identifies the account family (`manual`, `plaid`, `crypto_manual`, or `deleted`) and `account_id` identifies the account within that family.<br><br>
+        Submit one or more entries in the `balances` array. Each entry must specify a `month` (YYYY-MM) and `balance` value. `month` must be a past calendar month. The current month cannot be written through this endpoint.<br><br>
         `currency` may be provided for any balance entry. If omitted, it defaults to the account currency for manual/Plaid accounts, or the user's primary currency for crypto/deleted accounts.<br><br>
-        `symbol` may only be set when `account_type` is `crypto_manual` or `crypto_synced`. It is optional for `crypto_manual` accounts and tolerated for `deleted` accounts.<br><br>
-        `crypto_balance` may be provided for `crypto_manual`, `crypto_synced`, and `deleted` accounts, and is invalid for `manual` or `plaid` accounts.<br><br>
-        The response contains only the balance entries that were submitted in this request. 
+        `symbol` may be set for `crypto_manual` (optional) and `deleted` (tolerated) accounts. Do not provide it for `manual` or `plaid` accounts.<br><br>
+        `crypto_balance` may be provided for `crypto_manual` and `deleted` accounts. It is invalid for `manual` or `plaid` accounts.<br><br>
+        The response contains only the `type: historical` balance entries that were submitted in this request.
       operationId: upsertBalanceHistoryForAccount
       parameters:
         - name: account_type
           in: path
           required: true
-          description: Source family to update. Use `manual`, `plaid`, `crypto_manual`, or `deleted`.
+          description: Account family to update. Use `manual`, `plaid`, `crypto_manual`, or `deleted`.
           schema:
             type: string
             enum: [manual, plaid, crypto_manual, deleted]
@@ -6873,21 +7032,21 @@ paths:
               manual account bulk upsert:
                 value:
                   balances:
-                    - date: "2026-03-01"
+                    - month: "2026-03"
                       balance: "41500.0000"
-                    - date: "2026-04-01"
+                    - month: "2026-04"
                       balance: "41625.5000"
               crypto manual balance with symbol:
                 value:
                   balances:
-                    - date: "2026-03-01"
+                    - month: "2026-03"
                       balance: "56011.1200"
                       symbol: btc
                       crypto_balance: "0.852341920145782301"
               deleted account bulk upsert:
                 value:
                   balances:
-                    - date: "2026-03-01"
+                    - month: "2026-03"
                       symbol: btc
                       crypto_balance: "0.020000000000000000"
                       currency: usd
@@ -6896,55 +7055,59 @@ paths:
                 value:
                   balances:
                     - id: 601
-                      date: "2026-03-01"
+                      month: "2026-03"
                       balance: "41500.0000"
                       currency: usd
                       to_base: 41500
                       crypto_balance: null
       responses:
         "200":
-          description: Returns the modified balance entries only. Other historical
-            entries for the account are omitted from `balances`.
+          description: >-
+            Returns only the `type: historical` entries modified by this request.
+            Other historical entries for the account are omitted from `balances`.
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/balanceHistoryAccountObject"
               examples:
                 manual account bulk upsert:
-                  summary: Two upserted rows returned (not full account history)
+                  summary: Two upserted entries returned (not full account history)
                   value:
                     source:
                       type: manual
                       manual_account_id: 119807
                     balances:
-                      - id: 601
-                        date: "2026-03-01"
+                      - type: historical
+                        id: 601
+                        month: "2026-03"
                         balance: "41500.0000"
                         currency: usd
                         to_base: 41500
                         crypto_balance: null
-                      - id: 602
-                        date: "2026-04-01"
+                      - type: historical
+                        id: 602
+                        month: "2026-04"
                         balance: "41625.5000"
                         currency: usd
                         to_base: 41625.5
                         crypto_balance: null
                 crypto manual balance with symbol:
-                  summary: Single upserted row returned
+                  summary: Single upserted entry returned
                   value:
                     source:
                       type: crypto_manual
                       crypto_manual_id: 22001
                       symbol: btc
                     balances:
-                      - id: 603
-                        date: "2026-03-01"
+                      - type: historical
+                        id: 603
+                        month: "2026-03"
                         balance: "56011.1200"
                         currency: usd
                         to_base: 56011.12
                         crypto_balance: "0.852341920145782301"
                 deleted account bulk upsert:
-                  summary: Single upserted row returned
+                  summary: Single upserted entry returned
                   value:
                     source:
                       type: deleted
@@ -6957,15 +7120,17 @@ paths:
                       mask: "1234"
                       symbol: btc
                     balances:
-                      - id: 504
-                        date: "2026-03-01"
+                      - type: historical
+                        id: 504
+                        month: "2026-03"
                         balance: "1255"
                         currency: usd
                         to_base: 1255
                         crypto_balance: "0.020000000000000000"
         "400":
-          description: Bad Request. The entire request is rejected if any row in
-            `balances` fails validation; no rows are updated.
+          description: >-
+            Bad Request. If any entry in `balances` fails validation, the entire
+            request is rejected and no entries are updated.
           content:
             application/json:
               schema:
@@ -6986,30 +7151,34 @@ paths:
                     message: Invalid Request Body
                     errors:
                       - errMsg: "Invalid property 'foo' in request body."
-                invalid date:
+                invalid month format:
+                  value:
+                    message: Invalid Request Body
+                    errors:
+                      - errMsg: "Invalid value for property 'balances.0.month'. '2026-06-01' is not a valid month in YYYY-MM format."
+                current month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`date` must be the first day of a month."
+                      - errMsg: "`month` must not be the current month."
                         request_balances_index: 0
-                        code: VALIDATION_ERROR
-                future date:
+                future month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`date` must be in a past month."
+                      - errMsg: "`month` must not be in the future."
                         request_balances_index: 1
                 crypto balance not allowed:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`crypto_balance` may only be set when `account_type` is `crypto_manual`, `crypto_synced`, or `deleted`."
+                      - errMsg: "`crypto_balance` may only be set when `account_type` is `crypto_manual` or `deleted`."
                         request_balances_index: 0
-                invalid row in bulk request:
+                invalid entry in bulk request:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`symbol` may only be set when `account_type` is `crypto_manual` or `crypto_synced`."
+                      - errMsg: "`symbol` may only be set when `account_type` is `crypto_manual` or `deleted`."
                         request_balances_index: 1
         "401":
           $ref: "#/components/responses/unauthorizedToken"
@@ -7032,13 +7201,13 @@ paths:
         - balance_history
       summary: Delete all balance history for an account
       description: |-
-        Delete all historical balance entries for a single manual, Plaid, manual crypto, or deleted account. Crypto synced accounts require an additional `symbol` path parameter.
+        Delete all historical balance entries for a single manual, Plaid, manual crypto, or deleted account. For synced crypto symbol streams, use [DELETE /balance_history/crypto_synced/{account_id}/{symbol}](#tag/balance-history/DELETE/balance_history/crypto_synced/{account_id}/{symbol}).
       operationId: deleteBalanceHistoryForAccount
       parameters:
         - name: account_type
           in: path
           required: true
-          description: Source family to delete. Use `manual`, `plaid`, `crypto_manual`, or `deleted`.
+          description: Account family to delete. Use `manual`, `plaid`, `crypto_manual`, or `deleted`.
           schema:
             type: string
             enum: [manual, plaid, crypto_manual, deleted]
@@ -7076,9 +7245,9 @@ paths:
         - balance_history
       summary: Get balance history for a synced crypto symbol
       description: |-
-        Retrieve historical balance entries for a single synced crypto symbol stream.<br><br>
-        Use the `crypto_synced` account id together with a `symbol` path parameter to select one balance stream within that synced crypto account.<br><br>
-        When `start_date` and `end_date` are both provided, they must be first-of-month dates. `start_date` must not be in the future, while `end_date` may be in the future. If one of `start_date` or `end_date` is provided, the other is required. If neither is provided, all available history for the symbol stream is returned.
+        Retrieve monthly balance history for a single synced crypto symbol stream.<br><br>
+        The path selects one balance stream with a synced crypto account id and `symbol`.<br><br>
+        `start_month`, `end_month`, and current-month entries behave as described in [GET /balance_history](#tag/balance-history/GET/balance_history).
       operationId: getBalanceHistoryForCryptoSynced
       parameters:
         - name: account_id
@@ -7096,23 +7265,27 @@ paths:
             type: string
             minLength: 1
             maxLength: 25
-        - name: start_date
+        - name: start_month
           in: query
-          description: Optional start date for the requested history range in YYYY-MM-DD format. If set, `end_date` is also required. This must be the first day of a month and must not be in the future.
+          description: >-
+            Optional. Same format and constraints as `start_month` on
+            [GET /balance_history](#tag/balance-history/GET/balance_history).
           required: false
           schema:
             type: string
-            format: date
-        - name: end_date
+            pattern: '^\d{4}-(0[1-9]|1[0-2])$'
+        - name: end_month
           in: query
-          description: Optional end date for the requested history range in YYYY-MM-DD format. If set, `start_date` is also required. This must be the first day of a month.
+          description: >-
+            Optional. Same format and constraints as `end_month` on
+            [GET /balance_history](#tag/balance-history/GET/balance_history).
           required: false
           schema:
             type: string
-            format: date
+            pattern: '^\d{4}-(0[1-9]|1[0-2])$'
       responses:
         "200":
-          description: Historical balance entries for the synced crypto symbol stream
+          description: Monthly balance history for the synced crypto symbol stream
           content:
             application/json:
               schema:
@@ -7124,8 +7297,9 @@ paths:
                       crypto_synced_id: 33004
                       symbol: btc
                     balances:
-                      - id: 401
-                        date: "2026-02-01"
+                      - type: historical
+                        id: 401
+                        month: "2026-02"
                         balance: "6231.2800"
                         currency: usd
                         to_base: 6231.28
@@ -7137,16 +7311,16 @@ paths:
               schema:
                 $ref: "#/components/schemas/errorResponseObject"
               examples:
-                missing paired date:
+                missing paired month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`start_date` and `end_date` must either both be provided or both be omitted."
-                invalid range:
+                      - errMsg: "`start_month` and `end_month` must either both be provided or both be omitted."
+                invalid month format:
                   value:
-                    message: Request Validation Failure
+                    message: Invalid Request Parameters
                     errors:
-                      - errMsg: "`start_date` must be before or equal to `end_date`."
+                      - errMsg: "Invalid value for parameter: 'start_month'. '2026-06-01' is not a valid month in YYYY-MM format."
         "401":
           $ref: "#/components/responses/unauthorizedToken"
         "404":
@@ -7177,12 +7351,11 @@ paths:
       description: |-
         Upsert one or more historical balance entries for a single synced crypto symbol stream.<br><br>
         The path identifies both the synced crypto account and the symbol being updated.<br><br>
-        Submit one or more entries in the `balances` array. Each entry must specify a `date` and `balance` value.<br><br>
-        Balance history is monthly. Each entry's `date` must be the first day of a month and must be in a past month.<br><br>
+        Submit one or more entries in the `balances` array. Each entry must specify a `month` (YYYY-MM) and `balance` value. `month` must be a past calendar month. The current month cannot be written through this endpoint.<br><br>
         The request body may include an optional `symbol` on each balance entry. If provided, it must match the `symbol` path parameter. Omit `symbol` to use the path value.<br><br>
         `currency` may be provided for any balance entry. If omitted, it defaults to the user's primary currency for synced crypto balances.<br><br>
         `crypto_balance` may be provided for synced crypto balances.<br><br>
-        The response contains only the balance entries that were submitted in this request. 
+        The response contains only the `type: historical` balance entries that were submitted in this request.
       operationId: upsertBalanceHistoryForCryptoSynced
       parameters:
         - name: account_id
@@ -7210,44 +7383,49 @@ paths:
               synced crypto bulk upsert:
                 value:
                   balances:
-                    - date: "2026-03-01"
+                    - month: "2026-03"
                       balance: "6400.0000"
                       crypto_balance: "0.100020003000400050"
-                    - date: "2026-04-01"
+                    - month: "2026-04"
                       balance: "6500.0000"
                       crypto_balance: "0.100020003000400050"
       responses:
         "200":
-          description: Returns the modified balance entries only. Other historical
-            entries for the symbol stream are omitted from `balances`.
+          description: >-
+            Returns only the `type: historical` entries modified by this request.
+            Other historical entries for the symbol stream are omitted from
+            `balances`.
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/balanceHistoryAccountObject"
               examples:
                 synced crypto bulk upsert:
-                  summary: Two upserted rows returned (not full symbol history)
+                  summary: Two upserted entries returned (not full symbol history)
                   value:
                     source:
                       type: crypto_synced
                       crypto_synced_id: 33004
                       symbol: btc
                     balances:
-                      - id: 604
-                        date: "2026-03-01"
+                      - type: historical
+                        id: 604
+                        month: "2026-03"
                         balance: "6400.0000"
                         currency: usd
                         to_base: 6400
                         crypto_balance: "0.100020003000400050"
-                      - id: 605
-                        date: "2026-04-01"
+                      - type: historical
+                        id: 605
+                        month: "2026-04"
                         balance: "6500.0000"
                         currency: usd
                         to_base: 6500
                         crypto_balance: "0.100020003000400050"
         "400":
-          description: Bad Request. The entire request is rejected if any row in
-            `balances` fails validation; no rows are updated.
+          description: >-
+            Bad Request. If any entry in `balances` fails validation, the entire
+            request is rejected and no entries are updated.
           content:
             application/json:
               schema:
@@ -7263,17 +7441,22 @@ paths:
                     message: Invalid Request Body
                     errors:
                       - errMsg: "Invalid value for property 'balances'. Array must contain at least 1 element(s)"
-                invalid date:
+                invalid month format:
+                  value:
+                    message: Invalid Request Body
+                    errors:
+                      - errMsg: "Invalid value for property 'balances.0.month'. '2026-06-01' is not a valid month in YYYY-MM format."
+                current month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`date` must be the first day of a month."
+                      - errMsg: "`month` must not be the current month."
                         request_balances_index: 0
-                future date:
+                future month:
                   value:
                     message: Request Validation Failure
                     errors:
-                      - errMsg: "`date` must be in a past month."
+                      - errMsg: "`month` must not be in the future."
                         request_balances_index: 1
                 symbol mismatch:
                   value:
@@ -7281,9 +7464,9 @@ paths:
                     errors:
                       - errMsg: "`symbol` in request body (doge) does not match the path symbol (eth)."
                         request_balances_index: 0
-                invalid row in bulk request:
+                invalid entry in bulk request:
                   value:
-                    message: Request Validation Failure
+                    message: Invalid Request Body
                     errors:
                       - errMsg: "`balance` must be a valid numeric string or number."
                         request_balances_index: 1
@@ -7359,13 +7542,13 @@ paths:
         - balance_history
       summary: Delete a balance history entry
       description: |-
-        Delete a single monthly balance history entry by its id.
+        Delete a single stored (`type: historical`) monthly balance history entry by its id. Ephemeral `current` entries cannot be deleted this way.
       operationId: deleteBalanceHistoryEntry
       parameters:
         - name: id
           in: path
           required: true
-          description: Balance history row identifier to delete.
+          description: Historical balance entry identifier to delete.
           schema:
             type: integer
             format: int32
@@ -7379,7 +7562,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/errorResponseObject"
               example:
-                message: Request Validation Failure
+                message: Invalid Path Parameters
                 errors:
                   - errMsg: "Invalid value type for path parameter: 'id'. Expected 'number', received 'string'."
         "401":
@@ -7405,7 +7588,7 @@ paths:
       summary: Update details for a deleted account
       description: |-
         Update archived metadata for a deleted balance history source.<br><br>
-        Pass the `deleted` source id returned on `source.deleted_account_id`. This endpoint updates the stored deleted-source metadata used for all historical entries associated with that deleted source.
+        Pass the `deleted_account_id` from a `source.type: deleted` entry. The update applies to all historical entries associated with that deleted source.
       operationId: updateBalanceHistoryDetails
       parameters:
         - name: account_id