@lunch-money/developer-docs 2.11.0-preview.10 → 2.11.1-preview.1

package/README.md

@@ -1,65 +1,17 @@
 # @lunch-money/developer-docs
 
-Documentation content for the [Lunch Money](https://lunchmoney.app) developer APIs —
-the guides, v1/v2 reference docs, images, and doc-routing manifest that power the
-[Lunch Money developer portal](https://lunchmoney.dev).
+Developer documentation content for Lunch Money APIs.
 
-Most API consumers want the OpenAPI spec instead: **[`@lunch-money/v2-api-spec`](https://www.npmjs.com/package/@lunch-money/v2-api-spec)**
-is the canonical machine-readable API contract. This package is the human-facing docs
-content, primarily for the docs server that renders the portal.
+This package ships the public `developer-docs` repository content directories at the package root:
 
-## What's in the package
+- `docs/`
+- `v1/`
+- `v2/`
 
-Shipped verbatim at the package root:
-
-- `docs/` — version-independent guides (getting started, pagination, rate limiting, …)
-- `v1/` — v1 API reference markdown
-- `v2/` — v2 guides, images, and a **convenience copy** of the OpenAPI YAML under
-  `v2/spec/` (non-canonical; the canonical spec is `@lunch-money/v2-api-spec`)
-- `manifest.json` — doc routes, redirects, and sidebar structure
-
-## Consuming the content
-
-Resolve the package root, then read content files relative to it:
+The package version tracks the newest API version documented by this content. Server consumers should pin this package explicitly and resolve the package root with:
 
 ```js
-const path = require('path');
-const fs = require('fs');
-
 const docsRoot = path.dirname(require.resolve('@lunch-money/developer-docs/package.json'));
-const intro = fs.readFileSync(path.join(docsRoot, 'docs/getting-started.md'), 'utf8');
 ```
 
-`manifest.json` describes every page the docs server renders:
-
-```jsonc
-{
-  "pages": [
-    {
-      "path": "/amounts-and-balances",        // canonical URL
-      "file": "docs/amounts-and-balances.md",  // path within this package
-      "title": "Amounts & Balances",
-      "section": "GUIDES",                     // sidebar grouping
-      "type": "markdown",                      // "markdown" | "html" | "v1-slate"
-      "aliases": ["/v2/amounts-and-balances"]  // legacy URLs → 301 to path
-    }
-  ],
-  "redirects": [ /* { from, to, status } */ ],
-  "sidebar": { "docs": [ /* … */ ], "v1": [ /* … */ ] }
-}
-```
-
-## Versioning
-
-The package version tracks the newest API version this content documents (e.g. `2.11.x`
-documents the v2.11 API). Pin an exact version in server deployments so docs are
-deterministic.
-
-## Contributing
-
-Guides, spec, and the routing manifest are edited in the public
-[`developer-docs` repository](https://github.com/lunch-money/developer-docs) — see its
-README for how to add or move a page. This npm package is a published build of that
-content.
-
-_ISC licensed._
+The OpenAPI YAML under `v2/spec/` is included as a convenience copy because the docs tree is shipped verbatim. The canonical v2 API specification package is `@lunch-money/v2-api-spec`.

package/docs/introduction.md

@@ -2,6 +2,10 @@
 
 Welcome to the Lunch Money developer documentation. This site covers the **v2 API** — the current generation of the Lunch Money API — along with guides, a reference for the legacy v1 API, and tools for exploring the API without touching real data.
 
+> [!WARNING]
+> Alpha Release
+> The v2 API is in open alpha. It is subject to change during this review period and bugs may exist. We strongly encourage using the [mock service](#trying-the-api-without-real-data) or a test budget with sample data as your first step.
+
 ## Getting Started
 
 The v2 API is available at:

package/package.json

@@ -1,25 +1,22 @@
 {
   "name": "@lunch-money/developer-docs",
-  "version": "2.11.0-preview.10",
+  "version": "2.11.1-preview.1",
   "description": "Developer documentation content for Lunch Money APIs",
   "exports": {
     ".": "./package.json",
-    "./manifest.json": "./manifest.json",
     "./package.json": "./package.json"
   },
   "files": [
     "docs",
     "v1",
     "v2",
-    "manifest.json",
     "README.md"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "validate:manifest": "node scripts/validate-manifest.js",
-    "prepack": "node scripts/validate-manifest.js && node scripts/prepack.js",
+    "prepack": "node scripts/prepack.js",
     "postpack": "node scripts/postpack.js"
   },
   "keywords": [

package/v2/docs/version-history.md

@@ -5,6 +5,11 @@ The Lunch Money API spec uses a modified version of SEMVER for its versioning me
 - The minor version represents the number of main endpoints the current version of the spec supports.  For example, a version of the API that supports the /me, /categories, and /transactions endpoints would have a minor version of 3.
 - The revision number represents the number of updates since the last endpoint was added.  For example, each time changes are made to one of the existing three APIs as described above, the revision number will be bumped.
 
+## v2.11.1 - TBD
+- Add `GET /me/account/settings` and `PUT /me/account/settings` for account-level settings
+- Add `GET /me/user/settings` and `PUT /me/user/settings` for user-level display and formatting preferences
+- Document `GET /budgets/settings` response schema publicly; change `budget_period_quantity` to integer
+
 ## v2.11.0 - TBD
 - Add `GET /balance_history`
 - Add `GET /balance_history/{account_type}/{account_id}`

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

@@ -2,13 +2,17 @@ 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.
+    Welcome to the Lunch Money v2 API reference. This is the **v2.11.1** spec. It includes previews of the proposed `/crypto` and `/balance_history` endpoints. Only the mock service works with these endpoints.<br><br>
+    The most recent stable version of the API is v2.9.4 and is available at:
+    `https://api.lunchmoney.dev/v2`
+
+    ------------------------------------------------------------------------------------------------
 
     ### Introduction
 
-    The API is available at `https://lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
+    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).
 
-    API calls can <span class="red-text"><strong>change or delete</strong></span> your data. Any changes you make are <span class="red-text"><strong>permanent</strong></span>, just like they would be if you made changes using the web or mobile app.   Please refer to the [Getting Started Guide](https://lunchmoney.dev/v2/getting-started) before using the API.
+    <span class="red-text"><strong>The v2 API is in open alpha and is still subject to change. Use the mock server or a test budget when getting started.</strong></span>
 
     **Static Mock Server**
 
@@ -16,37 +20,40 @@ info:
 
     **Client Libraries & SDKs**
 
-    An official TypeScript SDK is available on [NPM](https://www.npmjs.com/package/@lunch-money/v2-api-spec) and [GitHub](https://github.com/lunch-money/lunch-money-js-v2). For Python or other languages, see [lunchmoney-clients](https://github.com/juftin/lunchmoney-clients) or generate a client from [this OpenAPI spec](/v2/openapi).
+    An official TypeScript SDK is available on [NPM](https://www.npmjs.com/package/@lunch-money/v2-api-spec) and [GitHub](https://github.com/lunch-money/lunch-money-js-v2). For Python or other languages, see [lunchmoney-clients](https://github.com/juftin/lunchmoney-clients) or generate a client from this OpenAPI spec.
 
     **Migrating from v1**
 
-    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://lunchmoney.dev/v2/migration-guide) for details.
+    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) for details.
 
     **Useful links**
-    - [Developer Portal](https://lunchmoney.dev/v2/introduction)
-    - [Getting Started Guide](https://lunchmoney.dev/v2/getting-started)
-    - [v2 API Overview](https://lunchmoney.dev/v2/overview)
-    - [Version History](https://lunchmoney.dev/v2/version-history)
-    - [Migration Guide](https://lunchmoney.dev/v2/migration-guide)
-    - [Rate Limits](https://lunchmoney.dev/v2/rate-limits)
+    - [Developer Portal](https://alpha.lunchmoney.dev/v2/introduction)
+    - [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started)
+    - [v2 API Overview](https://alpha.lunchmoney.dev/v2/overview)
+    - [Version History](https://alpha.lunchmoney.dev/v2/version-history)
+    - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide)
+    - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits)
   termsOfService: https://lunchmoney.dev/#current-status
   contact:
     email: devsupport@lunchmoney.app
   license:
     name: Apache 2.0
     url: http://www.apache.org/licenses/LICENSE-2.0.html
-  version: 2.11.0
+  version: 2.11.1
 
 servers:
   - url: https://api.lunchmoney.dev/v2
     description: v2 Lunch Money API Server - changes will affect real data!
-#  - url: https://lunchmoney.dev/v2
-  - url: https://lunchmoney.dev/v2
+#  - url: https://mock.lunchmoney.dev/v2
+  - url: https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/
     description: Static mock version of the v2 Lunch Money API Server
 
 tags:
   - name: me
-    description: View details and settings for the current user and account
+    description: View details and settings for the current user and account.<p>
+      Use [/me/account/settings](#tag/me/GET/me/account/settings) and
+      [/me/user/settings](#tag/me/GET/me/user/settings) for account- and
+      user-level preferences.
   - name: categories
     description: Work with categories
     externalDocs:
@@ -143,9 +150,15 @@ components:
           description: Unique ID for the current budgeting account
         budget_name:
           type: string
-          description: Name of the current budgeting account
+          description: Name of the current budgeting account.<p> Also available
+            as `display_name` on
+            [/me/account/settings](#tag/me/GET/me/account/settings), which is
+            the preferred endpoint for reading and updating account settings.
         primary_currency:
-          description: Primary currency for the current budgeting account
+          description: Primary currency for the current budgeting account.<p>
+            Also available on [/me/account/settings](#tag/me/GET/me/account/settings),
+            which is the preferred endpoint for reading and updating account
+            settings.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
         api_key_label:
@@ -2933,7 +2946,7 @@ components:
         currency:
           description: Three-letter lowercase currency code of the transaction
             in ISO 4217 format. Must match one of the [supported
-            currencies](https://lunchmoney.dev/v2/currencies). If not set
+            currencies](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/currencies). If not set
             defaults to the user account's primary currency.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
@@ -3669,6 +3682,371 @@ components:
         - budget_income_option
         - budget_rollover_left_to_budget
 
+    weekStartsOnEnum:
+      type: string
+      title: week starts on enum
+      enum:
+        - sunday
+        - monday
+      description: The day on which a calendar week begins.
+
+    monthYearFormatEnum:
+      type: string
+      title: month and year format enum
+      description: Format string for displaying month and year values
+        in the Lunch Money app.
+      enum:
+        - "MMMM YYYY"
+        - "MMM YYYY"
+        - "YYYY MMM"
+        - "MM YYYY"
+        - "MM-YYYY"
+        - "MM.YYYY"
+        - "MM/YYYY"
+        - "M YYYY"
+        - "M-YYYY"
+        - "M.YYYY"
+        - "M/YYYY"
+        - "YYYY M"
+        - "YYYY-M"
+        - "YYYY.M"
+        - "YYYY/M"
+        - "YYYY MM"
+        - "YYYY-MM"
+        - "YYYY.MM"
+        - "YYYY/MM"
+
+    monthDayYearFormatEnum:
+      type: string
+      title: month, day and year format enum
+      description: Format string for displaying full dates in the
+        Lunch Money app.
+      enum:
+        - "MMM D, YYYY"
+        - "D MMM YYYY"
+        - "YYYY MM DD"
+        - "YYYY-MM-DD"
+        - "YYYY.MM.DD"
+        - "YYYY/MM/DD"
+        - "YYYY M DD"
+        - "YYYY-M-DD"
+        - "YYYY.M.DD"
+        - "YYYY/M/DD"
+        - "YYYY MM D"
+        - "YYYY-MM-D"
+        - "YYYY.MM.D"
+        - "YYYY/MM/D"
+        - "YYYY M D"
+        - "YYYY-M-D"
+        - "YYYY.M.D"
+        - "YYYY/M/D"
+        - "DD MM YYYY"
+        - "DD-MM-YYYY"
+        - "DD.MM.YYYY"
+        - "DD/MM/YYYY"
+        - "DD M YYYY"
+        - "DD-M-YYYY"
+        - "DD.M.YYYY"
+        - "DD/M/YYYY"
+        - "D MM YYYY"
+        - "D-MM-YYYY"
+        - "D.MM.YYYY"
+        - "D/MM/YYYY"
+        - "D M YYYY"
+        - "D-M-YYYY"
+        - "D.M.YYYY"
+        - "D/M/YYYY"
+        - "M D YYYY"
+        - "M-D-YYYY"
+        - "M.D.YYYY"
+        - "M/D/YYYY"
+        - "MM D YYYY"
+        - "MM-D-YYYY"
+        - "MM.D.YYYY"
+        - "MM/D/YYYY"
+        - "MM DD YYYY"
+        - "MM-DD-YYYY"
+        - "MM.DD.YYYY"
+        - "MM/DD/YYYY"
+        - "M DD YYYY"
+        - "M-DD-YYYY"
+        - "M.DD.YYYY"
+        - "M/DD/YYYY"
+
+    monthDayFormatEnum:
+      type: string
+      title: month and day format enum
+      description: Format string for displaying month and day values
+        without a year.
+      enum:
+        - "MMM D"
+        - "MMM DD"
+        - "D MMM"
+        - "DD MMM"
+        - "MM D"
+        - "MM-D"
+        - "MM.D"
+        - "MM/D"
+        - "MM DD"
+        - "MM-DD"
+        - "MM.DD"
+        - "MM/DD"
+        - "M D"
+        - "M-D"
+        - "M.D"
+        - "M/D"
+        - "M DD"
+        - "M-DD"
+        - "M.DD"
+        - "M/DD"
+        - "D MM"
+        - "D-MM"
+        - "D.MM"
+        - "D/MM"
+        - "DD MM"
+        - "DD-MM"
+        - "DD.MM"
+        - "DD/MM"
+        - "D M"
+        - "D-M"
+        - "D.M"
+        - "D/M"
+        - "DD M"
+        - "DD-M"
+        - "DD.M"
+        - "DD/M"
+
+    accountSettingsObject:
+      type: object
+      title: account settings object
+      additionalProperties: false
+      description: Account-level settings for the budgeting account
+        associated with the authorized API token.
+      properties:
+        primary_currency:
+          description: Primary currency for the account.
+          allOf:
+            - $ref: "#/components/schemas/currencyEnum"
+        supported_currencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/currencyEnum"
+          description: Currencies available when creating or editing transactions,
+            balances, and other amounts in the Lunch Money app.
+        display_name:
+          type: string
+          nullable: true
+          description: Display name of the budgeting account in the Lunch Money
+            app.
+        locale:
+          type: string
+          description: Locale used for formatting dates and numbers in the
+            Lunch Money app (for example, `en-US`). When no locale is explicitly
+            stored for the account, the effective locale is derived from the
+            `default_locale` associated with `primary_currency` in the
+            currencies table (for example, `usd` → `en-US`, `cad` → `en-CA`,
+            `gbp` → `en-GB`).
+        auto_create_category_rules:
+          type: boolean
+          default: true
+          description: If `true`, category rules are created automatically when
+            categorizing transactions.
+        auto_create_suggested_transaction_rules:
+          type: boolean
+          default: true
+          description: If `true`, suggested transaction rules are created
+            automatically.
+        auto_review_transaction_on_update:
+          type: boolean
+          default: true
+          description: If `true`, transactions are marked as reviewed when
+            updated.
+        auto_review_transaction_on_creation:
+          type: boolean
+          default: true
+          description: If `true`, transactions are marked as reviewed when
+            created.
+      required:
+        - primary_currency
+        - supported_currencies
+        - display_name
+        - locale
+        - auto_create_category_rules
+        - auto_create_suggested_transaction_rules
+        - auto_review_transaction_on_update
+        - auto_review_transaction_on_creation
+
+    updateAccountSettingsRequestObject:
+      x-internal: true
+      type: object
+      additionalProperties: false
+      description: Request body for updating account settings. Include at least
+        one property to update.
+      properties:
+        primary_currency:
+          allOf:
+            - $ref: "#/components/schemas/currencyEnum"
+          description: If set, updates the account's primary currency.
+          x-updatable: true
+        supported_currencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/currencyEnum"
+          description: If set, replaces the list of supported currencies for the
+            account.
+          x-updatable: true
+        display_name:
+          type: string
+          nullable: true
+          description: If set, updates the display name of the budgeting account.
+          x-updatable: true
+        locale:
+          type: string
+          description: If set, updates the locale used for formatting dates and
+            numbers in the Lunch Money app.
+          x-updatable: true
+        auto_create_category_rules:
+          type: boolean
+          description: If set, updates whether category rules are created
+            automatically.
+          x-updatable: true
+        auto_create_suggested_transaction_rules:
+          type: boolean
+          description: If set, updates whether suggested transaction rules are
+            created automatically.
+          x-updatable: true
+        auto_review_transaction_on_update:
+          type: boolean
+          description: If set, updates whether transactions are marked as reviewed
+            when updated.
+          x-updatable: true
+        auto_review_transaction_on_creation:
+          type: boolean
+          description: If set, updates whether transactions are marked as reviewed
+            when created.
+          x-updatable: true
+
+    userSettingsObject:
+      type: object
+      title: user settings object
+      additionalProperties: false
+      description: User-level display and formatting preferences for the user
+        associated with the authorized API token.
+      properties:
+        show_debits_as_negative:
+          type: boolean
+          default: true
+          description: Display preference for how amounts are shown in the Lunch
+            Money app. When `true`, debits are shown as negative values and
+            credits as positive values.<p> This setting does **not** change
+            amount sign conventions in API responses. Amount fields such as
+            `amount` and `to_base` on transaction objects always use positive
+            values for debits and negative values for credits.
+        auto_suggest_payee:
+          type: boolean
+          default: true
+          description: If `true`, payee suggestions are shown when entering
+            transactions in the Lunch Money app.
+        month_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthYearFormatEnum"
+          default: "MMM YYYY"
+          description: Format string used when displaying month and year values.
+        month_day_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayYearFormatEnum"
+          default: "MMM D, YYYY"
+          description: Format string used when displaying full dates (month, day,
+            and year).
+        month_day_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayFormatEnum"
+          default: "MMM D"
+          description: Format string used when displaying month and day values
+            without a year.
+        show_am_pm:
+          type: boolean
+          default: true
+          description: If `true`, times are displayed using a 12-hour clock with
+            AM/PM. If `false`, times are displayed using a 24-hour clock.
+        week_starts_on:
+          allOf:
+            - $ref: "#/components/schemas/weekStartsOnEnum"
+          default: sunday
+          description: The day on which a calendar week begins.
+        always_display_year:
+          type: boolean
+          default: false
+          description: If `true`, dates always include the year and
+            `month_day_format` is not used.
+        always_display_weekday:
+          type: boolean
+          default: true
+          description: If `true`, weekday names are included when displaying
+            dates.
+      required:
+        - show_debits_as_negative
+        - auto_suggest_payee
+        - month_year_format
+        - month_day_year_format
+        - month_day_format
+        - show_am_pm
+        - week_starts_on
+        - always_display_year
+        - always_display_weekday
+
+    updateUserSettingsRequestObject:
+      x-internal: true
+      type: object
+      additionalProperties: false
+      description: Request body for updating user settings. Include at least one
+        property to update.
+      properties:
+        show_debits_as_negative:
+          type: boolean
+          description: If set, updates the display preference for amount signs in
+            the Lunch Money app. Does not affect amount sign conventions in API
+            responses.
+          x-updatable: true
+        auto_suggest_payee:
+          type: boolean
+          description: If set, updates whether payee suggestions are shown.
+          x-updatable: true
+        month_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthYearFormatEnum"
+          description: If set, updates the month and year display format.
+          x-updatable: true
+        month_day_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayYearFormatEnum"
+          description: If set, updates the full date display format.
+          x-updatable: true
+        month_day_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayFormatEnum"
+          description: If set, updates the month and day display format.
+          x-updatable: true
+        show_am_pm:
+          type: boolean
+          description: If set, updates whether times use a 12-hour (AM/PM) or
+            24-hour clock.
+          x-updatable: true
+        week_starts_on:
+          allOf:
+            - $ref: "#/components/schemas/weekStartsOnEnum"
+          description: If set, updates the day on which a calendar week begins.
+          x-updatable: true
+        always_display_year:
+          type: boolean
+          description: If set, updates whether dates always include the year.
+          x-updatable: true
+        always_display_weekday:
+          type: boolean
+          description: If set, updates whether weekday names are shown when
+            displaying dates.
+          x-updatable: true
+
     # Summary endpoint response schemas
     summaryResponseObject:
       type: object
@@ -4467,8 +4845,13 @@ paths:
       tags:
         - me
       summary: Get current user
-      description: Get details about the user associated with the supplied
-        authorization token.
+      description: |-
+        Get details about the user associated with the supplied authorization
+        token.<p> For account- and user-level preferences, prefer
+        [/me/account/settings](#tag/me/GET/me/account/settings) and
+        [/me/user/settings](#tag/me/GET/me/user/settings). Properties such as
+        `primary_currency` and `budget_name` remain on this response for
+        backwards compatibility.
       operationId: getMe
       parameters: []
       responses:
@@ -4492,6 +4875,165 @@ paths:
           $ref: "#/components/responses/rateLimited"
         "500":
           $ref: "#/components/responses/serverError"
+  /me/account/settings:
+    get:
+      tags:
+        - me
+      summary: Get account settings
+      description: Returns account-level settings for the budgeting
+        account associated with the authorized API token.
+      operationId: getAccountSettings
+      responses:
+        "200":
+          description: Account settings for the current budgeting account
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/accountSettingsObject"
+              example:
+                primary_currency: usd
+                supported_currencies:
+                  - usd
+                  - cad
+                  - jpy
+                display_name: "\U0001F3E0 Family budget"
+                locale: en-US
+                auto_create_category_rules: true
+                auto_create_suggested_transaction_rules: true
+                auto_review_transaction_on_update: true
+                auto_review_transaction_on_creation: true
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+    put:
+      tags:
+        - me
+      summary: Update account settings
+      description: |-
+        Updates account-level settings for the budgeting account
+        associated with the authorized API token.<p> You may submit the response from a
+        `GET /me/account/settings` as the request body; however, only certain
+        properties can be updated.<p> It is also possible to provide only the
+        properties to be updated in the request body, as long as the request
+        includes at least one updatable property.
+      operationId: updateAccountSettings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/updateAccountSettingsRequestObject"
+            examples:
+              Update display name:
+                value:
+                  display_name: "Travel budget"
+              Update automation preferences:
+                value:
+                  auto_create_category_rules: false
+                  auto_review_transaction_on_creation: false
+      responses:
+        "200":
+          description: Account settings updated successfully
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/accountSettingsObject"
+        "400":
+          description: Invalid request body
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/errorResponseObject"
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+  /me/user/settings:
+    get:
+      tags:
+        - me
+      summary: Get user settings
+      description: Returns user-level display and formatting preferences for the
+        user associated with the authorized API token.
+      operationId: getUserSettings
+      responses:
+        "200":
+          description: User settings for the authorized user
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/userSettingsObject"
+              example:
+                show_debits_as_negative: true
+                auto_suggest_payee: true
+                month_year_format: "MMM YYYY"
+                month_day_year_format: "MMM D, YYYY"
+                month_day_format: "MMM D"
+                show_am_pm: true
+                week_starts_on: sunday
+                always_display_year: false
+                always_display_weekday: true
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+    put:
+      tags:
+        - me
+      summary: Update user settings
+      description: |-
+        Updates user-level display and formatting preferences for the user
+        associated with the authorized API token.<p> You may submit the response
+        from a `GET /me/user/settings` as the request body; however, only
+        certain properties can be updated.<p> It is also possible to provide
+        only the properties to be updated in the request body, as long as the
+        request includes at least one updatable property.<p> Updating
+        `show_debits_as_negative` affects display in the Lunch Money app only.
+        Amount fields in API responses always use positive values for debits and
+        negative values for credits.
+      operationId: updateUserSettings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/updateUserSettingsRequestObject"
+            examples:
+              Update date formats:
+                value:
+                  month_year_format: "YYYY-MM"
+                  month_day_year_format: "YYYY-MM-DD"
+                  month_day_format: "MM-DD"
+              Use 24-hour time and Monday week start:
+                value:
+                  show_am_pm: false
+                  week_starts_on: monday
+      responses:
+        "200":
+          description: User settings updated successfully
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/userSettingsObject"
+        "400":
+          description: Invalid request body
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/errorResponseObject"
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
   /summary:
     get:
       tags:
@@ -8561,19 +9103,19 @@ paths:
           description: Sets the maximum number of transactions to return. If
             more match the filter criteria, the response will include a
             `has_more` attribute set to `true`. See
-            [Pagination](https://lunchmoney.dev/v2/pagination)
+            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
         - name: offset
           in: query
           schema:
             type: integer
           description: Sets the offset for the records returned. This is
             typically set automatically in the header. See
-            [Pagination](https://lunchmoney.dev/v2/pagination)
+            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
       responses:
         "200":
           description: Returns an array of transactions. <br><br>The `has_more`
             property is set to `true` if more transactions are available. See
-            [Pagination](https://lunchmoney.dev/v2/pagination)
+            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
           content:
             application/json:
               schema:
@@ -11620,7 +12162,9 @@ paths:
       description: |-
         Returns budget period and display settings for the budget
         associated with this API token.<p> These control how budget **periods** are calculated
-        (granularity, anchor date, rollover, and related options).
+        (granularity, anchor date, rollover, and related options). For general
+        budget preferences such as currency and locale, see
+        [/me/account/settings](#tag/me/GET/me/account/settings).
       operationId: getBudgetSettings
       responses:
         "200":

package/manifest.json

@@ -1,225 +0,0 @@
-{
-  "$comment": "Doc routing manifest (plans/remove_submodule.md, Phase 2). Pages, redirects, and sidebar for all documentation routes. 'file' paths are relative to the @lunch-money/developer-docs package root. Page 'aliases' are 301 redirects to the page path; 'redirects' entries carry their own status.",
-  "pages": [
-    {
-      "path": "/introduction",
-      "file": "docs/introduction.md",
-      "title": "Introduction",
-      "section": "INTRODUCTION",
-      "type": "markdown",
-      "aliases": ["/v2/introduction"]
-    },
-    {
-      "path": "/getting-started",
-      "file": "docs/getting-started.md",
-      "title": "Getting Started",
-      "section": "GUIDES",
-      "type": "markdown",
-      "aliases": ["/v2/getting-started"]
-    },
-    {
-      "path": "/pagination",
-      "file": "docs/pagination.md",
-      "title": "Pagination",
-      "section": "GUIDES",
-      "type": "markdown",
-      "aliases": ["/v2/pagination"]
-    },
-    {
-      "path": "/rate-limits",
-      "file": "docs/rate-limiting.md",
-      "title": "Rate Limiting",
-      "section": "GUIDES",
-      "type": "markdown",
-      "aliases": ["/v2/rate-limits"]
-    },
-    {
-      "path": "/currencies",
-      "file": "docs/currencies.md",
-      "title": "Supported Currencies",
-      "section": "GUIDES",
-      "type": "markdown",
-      "aliases": ["/v2/currencies"]
-    },
-    {
-      "path": "/amounts-and-balances",
-      "file": "docs/amounts-and-balances.md",
-      "title": "Amounts & Balances",
-      "section": "GUIDES",
-      "type": "markdown",
-      "aliases": ["/v2/amounts-and-balances"]
-    },
-    {
-      "path": "/using-with-ai",
-      "file": "docs/using-with-ai.md",
-      "title": "Using the API with AI",
-      "section": "GUIDES",
-      "type": "markdown",
-      "aliases": ["/v2/using-with-ai"]
-    },
-    {
-      "path": "/v2/overview",
-      "file": "v2/docs/intro-to-v2.md",
-      "title": "v2 API Overview",
-      "section": "REFERENCE",
-      "type": "markdown"
-    },
-    {
-      "path": "/v2/changelog",
-      "file": "v2/docs/version-history.md",
-      "title": "v2 API Changelog",
-      "section": "REFERENCE",
-      "type": "markdown",
-      "aliases": ["/v2/version-history"]
-    },
-    {
-      "path": "/v2/migration-guide",
-      "file": "v2/docs/migration-guide.md",
-      "title": "Migrating v1 to v2",
-      "section": "LEGACY APIs",
-      "type": "markdown"
-    },
-    {
-      "path": "/v2/changelog-visual",
-      "file": "v2/docs/changelog-visual.html",
-      "title": "v2 API Visual Changelog",
-      "section": "REFERENCE",
-      "type": "html"
-    },
-    {
-      "path": "/v1/changelog",
-      "file": "v1/_changelog.md",
-      "title": "v1 Changelog",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/changelog"]
-    },
-    {
-      "path": "/v1/user",
-      "file": "v1/_user.md",
-      "title": "v1 User",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/user"]
-    },
-    {
-      "path": "/v1/categories",
-      "file": "v1/_categories.md",
-      "title": "v1 Categories",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/categories"]
-    },
-    {
-      "path": "/v1/tags",
-      "file": "v1/_tags.md",
-      "title": "v1 Tags",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/tags"]
-    },
-    {
-      "path": "/v1/transactions",
-      "file": "v1/_transactions.md",
-      "title": "v1 Transactions",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/transactions"]
-    },
-    {
-      "path": "/v1/recurring-expenses",
-      "file": "v1/_recurring_expenses.md",
-      "title": "v1 Recurring Expenses",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/recurring-expenses"]
-    },
-    {
-      "path": "/v1/recurring-items",
-      "file": "v1/_recurring_items.md",
-      "title": "v1 Recurring Items",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/recurring-items"]
-    },
-    {
-      "path": "/v1/budget",
-      "file": "v1/_budget.md",
-      "title": "v1 Budget",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/budget"]
-    },
-    {
-      "path": "/v1/assets",
-      "file": "v1/_assets.md",
-      "title": "v1 Assets",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/assets"]
-    },
-    {
-      "path": "/v1/plaid-accounts",
-      "file": "v1/_plaid_accounts.md",
-      "title": "v1 Plaid Accounts",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/plaid-accounts"]
-    },
-    {
-      "path": "/v1/crypto",
-      "file": "v1/_crypto.md",
-      "title": "v1 Crypto",
-      "section": "V1 API REFERENCE",
-      "type": "v1-slate",
-      "aliases": ["/v1/reference/crypto"]
-    }
-  ],
-  "redirects": [
-    { "from": "/", "to": "/introduction", "status": 302 },
-    { "from": "/v2", "to": "/introduction", "status": 302 },
-    { "from": "/v2/", "to": "/introduction", "status": 302 },
-    { "from": "/v1", "to": "/v1/user", "status": 302 },
-    { "from": "/v1/docs", "to": "/v1/user", "status": 301 }
-  ],
-  "sidebar": {
-    "docs": [
-      { "label": "Introduction", "path": "/introduction" },
-      { "section": "GUIDES", "items": [
-        { "label": "Getting Started", "path": "/getting-started" },
-        { "label": "Amounts & Balances", "path": "/amounts-and-balances" },
-        { "label": "Pagination", "path": "/pagination" },
-        { "label": "Rate Limiting", "path": "/rate-limits" },
-        { "label": "Supported Currencies", "path": "/currencies" },
-        { "label": "Using the API with AI", "path": "/using-with-ai" }
-      ]},
-      { "section": "REFERENCE", "items": [
-        { "label": "v2 API Overview", "path": "/v2/overview" },
-        { "label": "v2 API Reference", "path": "/v2/docs", "external": true },
-        { "label": "v2 API Changelog", "path": "/v2/changelog" }
-      ]},
-      { "section": "LEGACY APIs", "items": [
-        { "label": "Migrating v1 → v2", "path": "/v2/migration-guide" },
-        { "label": "v1 API Reference", "path": "/v1/user", "external": true },
-        { "label": "v1 API Changelog", "path": "/v1/changelog" },
-        { "label": "Legacy v1 docs", "path": "https://v1.lunchmoney.dev/", "external": true }
-      ]}
-    ],
-    "v1": [
-      { "section": "V1 API REFERENCE", "items": [
-        { "label": "User", "path": "/v1/user" },
-        { "label": "Categories", "path": "/v1/categories" },
-        { "label": "Tags", "path": "/v1/tags" },
-        { "label": "Transactions", "path": "/v1/transactions" },
-        { "label": "Recurring Expenses", "path": "/v1/recurring-expenses" },
-        { "label": "Recurring Items", "path": "/v1/recurring-items" },
-        { "label": "Budget", "path": "/v1/budget" },
-        { "label": "Assets", "path": "/v1/assets" },
-        { "label": "Plaid Accounts", "path": "/v1/plaid-accounts" },
-        { "label": "Crypto", "path": "/v1/crypto" }
-      ]},
-      { "label": "v1 API Changelog", "path": "/v1/changelog" },
-      { "label": "Legacy v1 docs", "path": "https://v1.lunchmoney.dev/", "external": true }
-    ]
-  }
-}