@lunch-money/v2-api-spec 2.11.0 → 2.11.1-preview.10

package/lunch-money-api-v2.yaml

@@ -4,7 +4,7 @@ info:
   description: |-
     ### Introduction
 
-    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.
 
     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).
 
@@ -42,7 +42,7 @@ info:
   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
@@ -52,7 +52,12 @@ servers:
 
 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/user/settings](#tag/me/GET/me/user/settings) for user-wide
+      preferences, [/me/account/settings](#tag/me/GET/me/account/settings) for
+      account-wide preferences, and
+      [/me/user/account/settings](#tag/me/GET/me/user/account/settings) for
+      preferences specific to the current user and budgeting account.
   - name: categories
     description: Work with categories
     externalDocs:
@@ -153,9 +158,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:
@@ -3788,6 +3799,530 @@ components:
         - budget_income_option
         - budget_rollover_left_to_budget
 
+    weekStartsOnEnum:
+      x-internal: true
+      type: string
+      title: week starts on enum
+      enum:
+        - sunday
+        - monday
+      description: The day on which a calendar week begins.
+
+    monthYearFormatEnum:
+      x-internal: true
+      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:
+      x-internal: true
+      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:
+      x-internal: true
+      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"
+
+    localeEnum:
+      type: string
+      title: locale enum
+      description: Locale used for formatting numbers and currency amounts in
+        the Lunch Money app.
+      example: en-US
+      enum:
+        - sq-AL # Albanian (Albania)
+        - be-BY # Belarusian (Belarus)
+        - bg-BG # Bulgarian (Bulgaria)
+        - ca-ES # Catalan (Spain)
+        - zh-CN # Chinese (Simplified) (China)
+        - zh-HK # Chinese (Traditional) (Hong Kong)
+        - zh-TW # Chinese (Traditional) (Taiwan)
+        - hr-HR # Croatian (Croatia)
+        - cs-CZ # Czech (Czech Republic)
+        - da-DK # Danish (Denmark)
+        - nl-BE # Dutch (Belgium)
+        - nl-NL # Dutch (Netherlands)
+        - en-AU # English (Australia)
+        - en-CA # English (Canada)
+        - en-IN # English (India)
+        - en-IE # English (Ireland)
+        - en-MT # English (Malta)
+        - en-NZ # English (New Zealand)
+        - en-PH # English (Philippines)
+        - en-SG # English (Singapore)
+        - en-ZA # English (South Africa)
+        - en-GB # English (United Kingdom)
+        - en-US # English (United States)
+        - et-EE # Estonian (Estonia)
+        - fi-FI # Finnish (Finland)
+        - fr-BE # French (Belgium)
+        - fr-CA # French (Canada)
+        - fr-FR # French (France)
+        - fr-LU # French (Luxembourg)
+        - fr-CH # French (Switzerland)
+        - de-AT # German (Austria)
+        - de-DE # German (Germany)
+        - de-LU # German (Luxembourg)
+        - de-CH # German (Switzerland)
+        - el-CY # Greek (Cyprus)
+        - el-GR # Greek (Greece)
+        - iw-IL # Hebrew (Israel); modern replacement: he-IL
+        - hi-IN # Hindi (India)
+        - hu-HU # Hungarian (Hungary)
+        - is-IS # Icelandic (Iceland)
+        - in-ID # Indonesian (Indonesia); modern replacement: id-ID
+        - ga-IE # Irish (Ireland)
+        - it-IT # Italian (Italy)
+        - it-CH # Italian (Switzerland)
+        - ja-JP # Japanese (Japan)
+        - ko-KR # Korean (South Korea)
+        - lv-LV # Latvian (Latvia)
+        - lt-LT # Lithuanian (Lithuania)
+        - mk-MK # Macedonian (Macedonia)
+        - ms-MY # Malay (Malaysia)
+        - mt-MT # Maltese (Malta)
+        - no-NO # Norwegian (Norway)
+        - pl-PL # Polish (Poland)
+        - pt-BR # Portuguese (Brazil)
+        - pt-PT # Portuguese (Portugal)
+        - ro-RO # Romanian (Romania)
+        - ru-RU # Russian (Russia)
+        - sk-SK # Slovak (Slovakia)
+        - sl-SI # Slovenian (Slovenia)
+        - es-AR # Spanish (Argentina)
+        - es-BO # Spanish (Bolivia)
+        - es-CL # Spanish (Chile)
+        - es-CO # Spanish (Colombia)
+        - es-CR # Spanish (Costa Rica)
+        - es-DO # Spanish (Dominican Republic)
+        - es-EC # Spanish (Ecuador)
+        - es-SV # Spanish (El Salvador)
+        - es-GT # Spanish (Guatemala)
+        - es-HN # Spanish (Honduras)
+        - es-MX # Spanish (Mexico)
+        - es-NI # Spanish (Nicaragua)
+        - es-PA # Spanish (Panama)
+        - es-PY # Spanish (Paraguay)
+        - es-PE # Spanish (Peru)
+        - es-PR # Spanish (Puerto Rico)
+        - es-ES # Spanish (Spain)
+        - es-US # Spanish (United States)
+        - es-UY # Spanish (Uruguay)
+        - es-VE # Spanish (Venezuela)
+        - sv-SE # Swedish (Sweden)
+        - th-TH # Thai (Thailand)
+        - tr-TR # Turkish (Turkey)
+        - uk-UA # Ukrainian (Ukraine)
+        - vi-VN # Vietnamese (Vietnam)
+
+    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:
+          allOf:
+            - $ref: "#/components/schemas/localeEnum"
+          example: en-US
+          description: Locale used for formatting numbers and currency amounts
+            in the Lunch Money app (for example, `en-US`). See
+            [Supported Locales](https://lunchmoney.dev/v2/locales) for accepted
+            values. Date presentation is configured separately through
+            [GET /me/user/settings](#tag/me/GET/me/user/settings) and
+            [PUT /me/user/settings](#tag/me/PUT/me/user/settings). 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.
+        include_pending_in_totals:
+          type: boolean
+          default: true
+          description: If `true`, pending transactions are included in account
+            totals.
+      required:
+        - primary_currency
+        - supported_currencies
+        - display_name
+        - locale
+        - auto_create_category_rules
+        - auto_create_suggested_transaction_rules
+        - include_pending_in_totals
+
+    updateAccountSettingsRequestObject:
+      x-internal: true
+      type: object
+      additionalProperties: false
+      minProperties: 1
+      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:
+          allOf:
+            - $ref: "#/components/schemas/localeEnum"
+          example: en-US
+          description: If set, updates the locale used for formatting numbers
+            and currency amounts in the Lunch Money app. See
+            [Supported Locales](https://lunchmoney.dev/v2/locales) for accepted
+            values. Date presentation is configured separately through
+            [GET /me/user/settings](#tag/me/GET/me/user/settings) and
+            [PUT /me/user/settings](#tag/me/PUT/me/user/settings).
+          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
+        include_pending_in_totals:
+          type: boolean
+          description: If set, updates whether pending transactions are included
+            in account totals.
+          x-updatable: true
+
+    userAccountSettingsObject:
+      type: object
+      title: user account settings object
+      additionalProperties: false
+      description: Settings specific to the authorized user within the current
+        budgeting account.
+      properties:
+        auto_review_transaction_on_update:
+          type: boolean
+          default: true
+          description: If `true`, transactions are marked as reviewed when their
+            date, category, payee, amount, account, or notes are changed.
+        auto_review_transaction_on_creation:
+          type: boolean
+          default: true
+          description: If `true`, new manual transactions start as reviewed. If
+            `false`, they start as unreviewed.
+        default_manual_account_id:
+          type: integer
+          nullable: true
+          description: Manual account selected by default when the user creates a
+            manual transaction in the current budgeting account. Must identify a
+            manual account returned by
+            [GET /manual_accounts](#tag/manual_accounts/GET/manual_accounts) for
+            the current budgeting account. Set to `null` to clear the selection.
+      required:
+        - auto_review_transaction_on_update
+        - auto_review_transaction_on_creation
+        - default_manual_account_id
+
+    updateUserAccountSettingsRequestObject:
+      x-internal: true
+      type: object
+      additionalProperties: false
+      minProperties: 1
+      description: Request body for updating settings specific to the authorized
+        user within the current budgeting account. Include at least one property
+        to update.
+      properties:
+        auto_review_transaction_on_update:
+          type: boolean
+          description: If set, updates whether transactions are marked as reviewed
+            when their date, category, payee, amount, account, or notes are
+            changed.
+          x-updatable: true
+        auto_review_transaction_on_creation:
+          type: boolean
+          description: If set, updates whether new manual transactions start as
+            reviewed or unreviewed.
+          x-updatable: true
+        default_manual_account_id:
+          type: integer
+          nullable: true
+          description: If set, updates the manual account selected by default when
+            the user creates a manual transaction in the current budgeting
+            account. Must identify a manual account returned by
+            [GET /manual_accounts](#tag/manual_accounts/GET/manual_accounts) for
+            the current budgeting account. Set to `null` to clear the selection.
+          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
+      minProperties: 1
+      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
@@ -4574,8 +5109,16 @@ 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> Use [/me/user/settings](#tag/me/GET/me/user/settings) for
+        user-wide preferences,
+        [/me/account/settings](#tag/me/GET/me/account/settings) for account-wide
+        preferences, and
+        [/me/user/account/settings](#tag/me/GET/me/user/account/settings) for
+        preferences specific to the current user and budgeting account.
+        Properties such as `primary_currency` and `budget_name` remain on this
+        response for backwards compatibility.
       operationId: getMe
       parameters: []
       responses:
@@ -4599,6 +5142,247 @@ paths:
           $ref: "#/components/responses/rateLimited"
         "500":
           $ref: "#/components/responses/serverError"
+  /me/account/settings:
+    get:
+      tags:
+        - me
+      summary: Get account settings
+      description: >-
+        Returns settings for the current budgeting account. These settings apply
+        regardless of which user is accessing the account.
+      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
+                include_pending_in_totals: 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. Submit the full response from
+        `GET /me/account/settings` with one or more properties changed, or
+        provide only the properties to update. The request body must include at
+        least one 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
+                  include_pending_in_totals: 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 display and formatting preferences for the authorized user.
+        These settings apply across every budgeting account the user owns or
+        collaborates on.
+      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. Submit the full response from
+        `GET /me/user/settings` with one or more properties changed, or provide
+        only the properties to update. The request body must include at least
+        one 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"
+  /me/user/account/settings:
+    get:
+      tags:
+        - me
+      summary: Get user account settings
+      description: >-
+        Returns settings specific to the authorized user within the current
+        budgeting account. These settings do not affect other users or the
+        authorized user's settings in other budgeting accounts.
+      operationId: getUserAccountSettings
+      responses:
+        "200":
+          description: Settings for the authorized user in the current budgeting
+            account
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/userAccountSettingsObject"
+              example:
+                auto_review_transaction_on_update: true
+                auto_review_transaction_on_creation: true
+                default_manual_account_id: null
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+    put:
+      tags:
+        - me
+      summary: Update user account settings
+      description: |-
+        Updates settings specific to the authorized user within the current
+        budgeting account. Submit the full response from
+        `GET /me/user/account/settings` with one or more properties changed, or
+        provide only the properties to update. The request body must include at
+        least one property.
+      operationId: updateUserAccountSettings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/updateUserAccountSettingsRequestObject"
+            examples:
+              Update review preference:
+                value:
+                  auto_review_transaction_on_creation: false
+              Clear default manual account:
+                value:
+                  default_manual_account_id: null
+      responses:
+        "200":
+          description: User account settings updated successfully
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/userAccountSettingsObject"
+              examples:
+                Update review preference:
+                  value:
+                    auto_review_transaction_on_update: true
+                    auto_review_transaction_on_creation: false
+                    default_manual_account_id: null
+                Clear default manual account:
+                  value:
+                    auto_review_transaction_on_update: true
+                    auto_review_transaction_on_creation: true
+                    default_manual_account_id: null
+        "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:
@@ -11734,7 +12518,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":