@lunch-money/developer-docs 2.11.2-preview.9 → 2.11.2

package/README.md

@@ -45,22 +45,10 @@ const intro = fs.readFileSync(path.join(docsRoot, 'docs/getting-started.md'), 'u
     }
   ],
   "redirects": [ /* { from, to, status } */ ],
-  "sidebar": {
-    "docs": [
-      {
-        "section": "OAUTH",
-        "collapsed": true, // optional; initially collapse this section
-        "items": [ /* { label, path, external? } */ ]
-      }
-    ],
-    "v1": [ /* … */ ]
-  }
+  "sidebar": { "docs": [ /* … */ ], "v1": [ /* … */ ] }
 }
 ```
 
-Sidebar sections initially appear expanded unless their optional `collapsed`
-property is `true`.
-
 ## Versioning
 
 The package version tracks the newest API version this content documents (e.g. `2.11.x`

package/docs/STYLE_GUIDE.md

@@ -20,6 +20,10 @@ history entries.
   legal company name is required.
 - Use “Developer Portal,” “Developers page,” and “API reference” consistently.
   Preserve different capitalization only for an exact UI label.
+- Use “budget account” for the Lunch Money data container that holds a budget,
+  transactions, categories, and financial accounts. Use “account” only when the
+  context is unambiguous, and preserve exact UI labels such as “Create a New
+  Budget Account.”
 - Write “v1” and “v2” in prose. Use “V2 API” only where it is an established
   proper label, such as the rendered reference title.
 - Distinguish authentication from authorization, personal access tokens from

package/docs/branding-your-app.md

@@ -45,7 +45,7 @@ A few common, low-friction ways to brand an integration:
 
 1. **README or docs** — a short "Built with Lunch Money" line plus the Powered by badge linking to <a href="https://lunchmoney.app/" target="_blank" rel="noopener noreferrer">lunchmoney.app</a>
 2. **App footer or about screen** — the Powered by badge next to your own branding
-3. **Onboarding or connect flow** — official logo when asking users to connect their Lunch Money account through OAuth. Applications intended for other users should not ask them to paste a personal access token; see the [OAuth overview](/oauth)
+3. **Onboarding or connect flow** — official logo when prompting users to authorize or paste an access token
 4. **Community listings** — consistent naming ("My Tool for Lunch Money") so users can find and trust your project
 
 Keep your own product name primary. Lunch Money branding should signal the connection, not compete with your identity.

package/docs/getting-started.md

@@ -8,9 +8,9 @@ Most users interact with their Lunch Money data using the official web or mobile
 > Changes made via the API are permanent and cannot be undone. Always use a test budget when getting started.
 
 
-## Create a test budgeting account
+## Create a test budget account
 
-Since changes to your data made by the API are permanent, the best way to begin interacting with the API is to <a href="https://support.lunchmoney.app/miscellaneous/unlimited-budgeting-accounts" target="_blank" rel="noopener noreferrer">create a new test budgeting account</a> in your existing Lunch Money account. As you start using the API, you can interact with this test account and ensure that your real data is not modified.
+Since changes to your data made by the API are permanent, the best way to begin interacting with the API is to <a href="https://support.lunchmoney.app/miscellaneous/unlimited-budgeting-accounts" target="_blank" rel="noopener noreferrer">create a new test budget account</a> in your existing Lunch Money account. As you start using the API, you can interact with this test account and ensure that your real data is not modified.
 
 :::tabs
 
@@ -27,39 +27,37 @@ Choose the option to "Set up Demo". This will add categories, accounts, tags and
 ![Add Demo Data](/images/DemoData.png)
 :::
 
-## Getting a personal access token
+## Getting an access token
 
-Lunch Money API requests are authenticated using the Bearer Token authentication method. In plain English, this means that you will pass a personal access token associated with your budgeting account to Lunch Money. This is so we know which account to operate on and that the request came from someone who can access that account.
-
-This guide uses a personal access token so you can explore the API with your own budgeting account. If you are building an application that other people will connect to Lunch Money, start with the [OAuth overview](/oauth) instead.
+Lunch Money API requests are authenticated using the Bearer Token authentication method. In plain English, this means that you will pass a token associated with your budget account to Lunch Money. This is so we know which account to operate on and that the request came from someone who can access that account.
 
 :::tabs
 
 @tab 1. Go to the Developers Page
 
-Navigate to <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">the developers page in the Lunch Money web app</a>. Look at the green circle in the upper right hand corner and make sure that it is showing the test account that you just created. If you aren't sure which account is active, you can click on the green circle to bring up the "Switch Accounts" dialog. This will show you the full names of all the accounts associated with your account. Select the test budgeting account you created.
+Navigate to <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">the developers page in the Lunch Money web app</a>. Look at the green circle in the upper right hand corner and make sure that it is showing the test account that you just created. If you aren't sure which account is active, you can click on the green circle to bring up the "Switch Accounts" dialog. This will show you the full names of all the accounts associated with your account. Select the test budget account you created.
 ![Green Budgets Icon](/images/green_budget.png)
 
 @tab 2. Request Access Token
-In the upper right hand corner of the page, give your personal access token a label and specify what you are using it for. When you're done, hit the "Request Access Token" button.
+In the upper right hand corner of the page, give your access token a label and specify what you are using it for. When you're done, hit the "Request Access Token" button.
 ![Request Token](/images/RequestAccessToken.png)
 
 @tab 3. Save Access Token
-After you do this, the web page will show you a long alphanumeric string. This is your personal access token. Hit the copy button and save this token somewhere safe. It is only shown to you when you create it.
+After you do this, the web page will show you a long alphanumeric string. This is your access token. Hit the copy button and save this token somewhere safe. It is only shown to you when you create it.
 :::
 
-Congratulations! You've got a personal access token and are ready to make an API request! Later, when you are more comfortable with the API, you can repeat this process to create a new personal access token associated with your real budget.
+Congratulations! You've got an access token and are ready to make an API request! Later, when you are more comfortable with the API, you can repeat this process to create a new access token associated with your real budget.
 
 > [!WARNING]
-> Treat your personal access tokens like passwords. Don't share them with anyone you don't trust.
+> Treat your access tokens like passwords. Don't share them with anyone you don't trust.
 
-If you ever worry that your personal access token has been compromised, you can always come back to the Developers page and hit the Revoke button.
+If you ever worry that your access token has been compromised, you can always come back to the Developers page and hit the Revoke button.
 
 > [!NOTE]
-> Give your personal access tokens descriptive names so you can easily identify and revoke them later if needed.
+> Give your access tokens descriptive names so you can easily identify and revoke them later if needed.
 
 
-## Using your personal access token
+## Using your access token
 
 When you start to write code that makes API calls, you will need to include this token in each request using an Authorization header. Here is an example curl request:
 
@@ -70,7 +68,7 @@ curl --location 'https://api.lunchmoney.dev/v2/me' \
 
 If this doesn't make sense yet, that's OK!
 
-There is an easier way to use your personal access token to make requests. Head over to the [API Reference Documentation](/v2/docs).
+There is an easier way to use your access token to make requests. Head over to the [API Reference Documentation](/v2/docs).
 
 :::tabs
 
@@ -87,8 +85,6 @@ This will pop up a dialog box that you can use to send an API request. This is a
 
 From here, you can explore the rest of the Lunch Money API and start thinking about what you might do with it.
 
-When you are ready to build an application that other Lunch Money users can connect to, [learn how OAuth grants access without asking users to share personal access tokens](/oauth).
-
 ## What can you build?
 
 The Lunch Money community has already built a wide variety of tools — automations, importers, dashboards, and more. Check out the <a href="https://lunchmoney.app/developers#community-projects" target="_blank" rel="noopener noreferrer">Developer Tools & Community Projects</a> list for inspiration, or drop by the <a href="https://discord.com/channels/842337014556262411/1134597088504729780" target="_blank" rel="noopener noreferrer">Show and Tell channel</a> on Discord to see what others are sharing.

package/docs/introduction.md

@@ -10,7 +10,7 @@ The v2 API is available at:
 https://api.lunchmoney.dev/v2
 ```
 
-To explore the API or work with your own budgeting account, create a personal access token on the <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">Developers page</a>. If you are building an application for other Lunch Money users, [use OAuth](/oauth) instead. Both kinds of access token are sent as a Bearer token with each request:
+Get your access token from the <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">Lunch Money app developers page</a> and include it as a Bearer token in every request:
 
 ```http
 Authorization: Bearer YOUR_ACCESS_TOKEN
@@ -59,6 +59,5 @@ Join the conversation in the <a href="https://lunchmoney.app/discord" target="_b
 **Useful links:**
 - <a href="/v2/docs">Interactive API Reference</a>
 - [Getting started guide](/getting-started)
-- [OAuth overview](/oauth)
 - <a href="https://github.com/lunch-money/awesome-lunchmoney" target="_blank" rel="noopener noreferrer">Awesome Lunch Money Projects</a>
 - [Contact: devsupport@lunchmoney.app](mailto:devsupport@lunchmoney.app)

package/manifest.json

@@ -73,102 +73,6 @@
       "type": "markdown",
       "aliases": ["/v2/branding-your-app"]
     },
-    {
-      "path": "/oauth",
-      "file": "docs/oauth/index.md",
-      "title": "OAuth Overview",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth", "/v2/oauth/"]
-    },
-    {
-      "path": "/oauth/concepts",
-      "file": "docs/oauth/concepts.md",
-      "title": "OAuth Concepts",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/concepts"]
-    },
-    {
-      "path": "/oauth/register-client",
-      "file": "docs/oauth/register-client.md",
-      "title": "Register an OAuth Client",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/register-client"]
-    },
-    {
-      "path": "/oauth/authorization-code",
-      "file": "docs/oauth/authorization-code.md",
-      "title": "Implement Authorization",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/authorization-code"]
-    },
-    {
-      "path": "/oauth/sample-applications",
-      "file": "docs/oauth/sample-applications.md",
-      "title": "OAuth Sample Applications",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/sample-applications"]
-    },
-    {
-      "path": "/oauth/development",
-      "file": "docs/oauth/development.md",
-      "title": "Develop and Test",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/development"]
-    },
-    {
-      "path": "/oauth/tokens",
-      "file": "docs/oauth/tokens.md",
-      "title": "Token Lifecycle",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/tokens"]
-    },
-    {
-      "path": "/oauth/security",
-      "file": "docs/oauth/security.md",
-      "title": "OAuth Security",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/security"]
-    },
-    {
-      "path": "/oauth/troubleshooting",
-      "file": "docs/oauth/troubleshooting.md",
-      "title": "Troubleshoot OAuth",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/troubleshooting"]
-    },
-    {
-      "path": "/oauth/review-and-approval",
-      "file": "docs/oauth/review-and-approval.md",
-      "title": "OAuth Client Review and Approval",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/review-and-approval"]
-    },
-    {
-      "path": "/oauth/native-apps",
-      "file": "docs/oauth/native-apps.md",
-      "title": "Native Apps",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/native-apps"]
-    },
-    {
-      "path": "/oauth/scopes",
-      "file": "docs/oauth/scopes.md",
-      "title": "OAuth Scopes",
-      "section": "OAUTH",
-      "type": "markdown",
-      "aliases": ["/v2/oauth/scopes"]
-    },
     {
       "path": "/v2/overview",
       "file": "v2/docs/intro-to-v2.md",
@@ -307,20 +211,6 @@
         { "label": "Using the API with AI", "path": "/using-with-ai" },
         { "label": "Branding your App", "path": "/branding-your-app" }
       ]},
-      { "section": "OAUTH", "collapsed": true, "items": [
-        { "label": "OAuth Overview", "path": "/oauth" },
-        { "label": "Concepts", "path": "/oauth/concepts" },
-        { "label": "Register a Client", "path": "/oauth/register-client" },
-        { "label": "Implement Authorization", "path": "/oauth/authorization-code" },
-        { "label": "Sample Applications", "path": "/oauth/sample-applications" },
-        { "label": "Develop and Test", "path": "/oauth/development" },
-        { "label": "Token Lifecycle", "path": "/oauth/tokens" },
-        { "label": "Security", "path": "/oauth/security" },
-        { "label": "Troubleshooting", "path": "/oauth/troubleshooting" },
-        { "label": "Review and Approval", "path": "/oauth/review-and-approval" },
-        { "label": "Native Apps", "path": "/oauth/native-apps" },
-        { "label": "Scope Catalog", "path": "/oauth/scopes" }
-      ]},
       { "section": "REFERENCE", "items": [
         { "label": "v2 API Overview", "path": "/v2/overview" },
         { "label": "v2 API Reference", "path": "/v2/docs", "external": true },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunch-money/developer-docs",
-  "version": "2.11.2-preview.9",
+  "version": "2.11.2",
   "description": "Developer documentation content for Lunch Money APIs",
   "exports": {
     ".": "./package.json",
@@ -18,8 +18,8 @@
     "access": "public"
   },
   "scripts": {
-    "validate:manifest": "node ../../scripts/generate-oauth-scope-catalog.js --check && node scripts/validate-manifest.js",
-    "prepack": "node ../../scripts/generate-oauth-scope-catalog.js --check && node scripts/validate-manifest.js && node scripts/prepack.js",
+    "validate:manifest": "node scripts/validate-manifest.js",
+    "prepack": "node scripts/validate-manifest.js && node scripts/prepack.js",
     "postpack": "node scripts/postpack.js"
   },
   "keywords": [

package/v1/_user.md

@@ -11,8 +11,8 @@ This API (v1) will not progress to a generally available state. For new projects
 | user_id        | number | false    | Unique identifier for user                                                              |
 | user_name      | string | false    | User's name                                                                             |
 | user_email     | string | false    | User's email                                                                            |
-| account_id     | number | false    | Unique identifier for the associated budgeting account                                  |
-| budget_name    | string | false    | Name of the associated budgeting account                                                |
+| account_id     | number | false    | Unique identifier for the associated budget account                                     |
+| budget_name    | string | false    | Name of the associated budget account                                                   |
 | primary_currency|string | false    | Primary currency from user's settings                                                   |
 | api_key_label  | string | true     | User-defined label of the developer API key used. Returns null if nothing has been set. |
 

package/v2/docs/intro-to-v2.md

@@ -10,7 +10,7 @@ All API requests require a Bearer token in the `Authorization` header:
 Authorization: Bearer YOUR_ACCESS_TOKEN
 ```
 
-Use a personal access token for API exploration or work with your own budgeting account. The [Getting started guide](/getting-started) walks through creating one on the <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">Lunch Money Developers page</a> and making your first request. Applications built for other Lunch Money users should use an [OAuth access token issued after the user authorizes the application](/oauth).
+Get your access token from the <a href="https://my.lunchmoney.app/developers" target="_blank" rel="noopener noreferrer">Lunch Money Developers page</a>. See the [Getting started guide](/getting-started) for a step-by-step walkthrough including how to create a test budget.
 
 ## Base URL
 

package/v2/docs/migration-guide.md

@@ -317,10 +317,10 @@ GET /v2/plaid_accounts/123
 GET /v2/tags/1
 ```
 
-**Migration Strategy**: 
+**Migration Strategy**:
 - Maintain a local cache of categories, accounts, and tags
-- Update your code to use IDs and fetch related objects separately when needed
-- Consider batching requests or using the bulk endpoints to reduce API calls
+- Fetch `GET /manual_accounts` and `GET /plaid_accounts` once and build an ID-to-account map. To filter transactions by account name, resolve the name to its account type and ID, then use `manual_account_id` or `plaid_account_id` with `GET /transactions`
+- Refresh cached related objects when their metadata changes instead of fetching them once per transaction
 
 #### Removed Properties
 
@@ -415,14 +415,17 @@ See the [Amounts & balances guide](/amounts-and-balances) for the full sign conv
 #### Split and Grouped Transactions
 
 **Split Transactions**:
-- Parents of split transactions (`is_parent: true`) are not returned by default in `GET /transactions`
+- Parents of split transactions (`is_split_parent: true`) are not returned by default in `GET /transactions`
 - Split transactions include `split_parent_id` pointing to the parent
 - Use `GET /transactions/:id` to get parent with full `children` array
 - Use `GET /transactions` with query param `include_split_parents=true` to include parents in list
 
+> [!WARNING] Prevent duplicate split processing
+> A v1 integration may see split children returned by v2 as new transactions because their parent is omitted by default. Before treating a transaction as new or attempting to split it, check `split_parent_id`. A non-null value identifies an existing split child and points to its parent transaction.
+
 **Grouped Transactions**:
 - Transactions that have been grouped are not returned by default
-- Only the group transaction (`is_group: true`) is returned
+- Only the group transaction (`is_group_parent: true`) is returned
 - Use `GET /transactions/:id` to get details of grouped transactions in the transaction group's `children` array.
 
 

package/v2/docs/version-history.md

@@ -5,17 +5,13 @@ 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.2 - TBD
-- Add OAuth 2.0 bearer-token authentication to the v2 API, allowing applications to access Lunch Money on behalf of users who authorize them
-- Document and enforce required OAuth scopes for every v2 operation and publish the scope and scope-group catalog mapped to V2 `operationId` values.
-  - Added a new `403` `insufficient_scope` response
-- Document the OAuth 2.0 authorization-code flow used to obtain access tokens
-- Add `include_files` query parameter to `GET /transactions/{id}`
-
-## v2.11.1 - TBD
+## v2.11.2 - Nov 7, 2026
+- Allow `balance_as_of` to be `null` in manual account responses
+
+## v2.11.1 - Sep 28, 2026
 - 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
-- Add `GET /me/user/account/settings` and `PUT /me/user/account/settings` for settings specific to a user and budgeting account
+- Add `GET /me/user/account/settings` and `PUT /me/user/account/settings` for settings specific to a user and budget account
 - Add `include_pending_in_totals` to `GET /me/account/settings` and `PUT /me/account/settings`
 - Add `default_manual_account_id` to `GET /me/user/account/settings` and `PUT /me/user/account/settings`
 - Document `GET /budgets/settings` response schema publicly; change `budget_period_quantity` to integer

package/v2/spec/AGENTS.md

@@ -41,12 +41,6 @@ Follow these rules whenever editing `v2/spec/lunch-money-api-v2.yaml`:
 - Add links when they materially help consumers discover a related endpoint or relevant guide.
 - Do not add links that merely restate obvious navigation.
 
-### YAML formatting
-
-- Write each description paragraph as a single line. Never hard-wrap prose to a column: inside a folded scalar a line break becomes a space, so a wrap landing beside punctuation or markup silently corrupts the rendered text.
-- Use a folded block (`>-`) only when a description has more than one paragraph, separated by a blank line. A single-paragraph description stays on the key line.
-- Never use a literal block (`|`, `|-`) for prose — newlines become significant, so reflowing later changes the output.
-
 ### Examples
 
 Examples are selective documentation aids, not a required artifact for every spec change.