@lunch-money/v2-api-spec 2.11.0-preview.17 → 2.11.0-preview.18

package/lunch-money-api-v2.yaml

@@ -14,11 +14,11 @@ info:
     These docs are interactive — use **Test request** on any endpoint to call the API from this page.
     Choose a LIVE or MOCK service from the Server dropdown.
     Requests sent to `https://api.lunchmoney.dev/v2` can <span class="red-text"><strong>change or delete</strong></span> your data and are <span class="red-text"><strong>permanent</strong></span>.
-    See the [Getting Started Guide](https://lunchmoney.dev/v2/getting-started) before using the live API.
+    See the [Getting Started Guide](http://localhost:3000/v2/getting-started) before using the live API.
     
     **Static mock server**
 
-    Explore without risk to real data. Select `http://mock.lunchmoney.dev/v2` in the Server dropdown to work with static mock data.
+    Explore without risk to real data. Select `http://localhost:3000/v2` in the Server dropdown to work with static mock data.
     POST, PUT, and DELETE requests will return realistic responses, but do not change the mock data.
     
 
@@ -28,14 +28,14 @@ info:
 
     **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](http://localhost:3000/v2/migration-guide) for details.
 
     **Useful links**
-    - [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)
+    - [Getting Started Guide](http://localhost:3000/v2/getting-started)
+    - [v2 API Overview](http://localhost:3000/v2/overview)
+    - [Version History](http://localhost:3000/v2/version-history)
+    - [Migration Guide](http://localhost:3000/v2/migration-guide)
+    - [Rate Limits](http://localhost:3000/v2/rate-limits)
   termsOfService: https://lunchmoney.dev/#current-status
   contact:
     email: devsupport@lunchmoney.app
@@ -47,7 +47,7 @@ info:
 servers:
   - url: https://api.lunchmoney.dev/v2
     description: ⚠ LIVE — changes real Lunch Money data
-  - url: http://mock.lunchmoney.dev/v2
+  - url: http://localhost:3000/v2
     description: MOCK — static demo data, no API key required
 
 tags:
@@ -991,16 +991,19 @@ components:
           example: Cold Wallet BTC
         display_name:
           type: string
+          nullable: true
           minLength: 1
           maxLength: 45
-          description: Optional display name for the manual crypto asset. If
-            omitted, clients may derive one from `institution_name` + `name`.
+          description: Display name for the manual crypto asset. If omitted or
+            `null`, clients may derive one from `institution_name` + `name`.
           example: Cold Storage
         institution_name:
           type: string
+          nullable: true
           minLength: 1
           maxLength: 50
-          description: Optional institution or wallet provider display name
+          description: Institution or wallet provider display name. If omitted
+            or `null`, no institution name is set.
           example: Ledger
         balance:
           oneOf:
@@ -1256,15 +1259,19 @@ components:
           example: My Savings Account
         institution_name:
           type: string
+          nullable: true
           example: Bank of the West
-          description: Name of institution holding the manual account
+          description: Name of the institution holding the manual account. If
+            omitted or `null`, no institution name is set.
           minLength: 1
           maxLength: 50
         display_name:
           type: string
-          description: Display name of the manual account as set by user or
-            derived from the `institution_name` and `name` if not explicitly
-            set.<br> This must be unique for the budgeting account.
+          nullable: true
+          description: Display name of the manual account. If omitted or
+            `null`, it is derived from `institution_name` and `name`. An
+            explicitly set display name must be unique for the budgeting
+            account.
           example: Savings
         type:
           description: The type of manual account
@@ -1272,8 +1279,10 @@ components:
             - $ref: "#/components/schemas/accountTypeEnum"
         subtype:
           type: string
-          description: An optional manual account subtype. Examples include<br>
-            - retirement - checking - savings - prepaid credit card
+          nullable: true
+          description: Manual account subtype. If omitted or `null`, no subtype
+            is set. Examples include retirement, checking, savings, and prepaid
+            credit card.
           minLength: 1
           maxLength: 100
           example: prepaid credit card
@@ -3038,7 +3047,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](http://localhost:3000/v2/currencies). If not set
             defaults to the user account's primary currency.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
@@ -3394,9 +3403,10 @@ components:
         category_id:
           type: integer
           format: int32
-          description: Unique identifier for associated category_id. Category
-            must already exist for the account. Will inherit category from the
-            parent if not defined.
+          nullable: true
+          description: Category ID for the child transaction. The category must
+            already exist for the account. If omitted, the child inherits the
+            parent category. If `null`, the child has no category.
         tag_ids:
           type: array
           description: The IDs of any tags to apply to this split child
@@ -3406,7 +3416,10 @@ components:
             format: int32
         notes:
           type: string
-          description: Will inherit notes from parent if not defined.
+          nullable: true
+          description: Notes for the child transaction. If omitted, the child
+            inherits the parent notes. If `null` or an empty string, the child
+            has no notes.
       required:
         - amount
 
@@ -8662,19 +8675,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](http://localhost:3000/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](http://localhost:3000/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](http://localhost:3000/v2/pagination)
           content:
             application/json:
               schema:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunch-money/v2-api-spec",
-  "version": "2.11.0-preview.17",
+  "version": "2.11.0-preview.18",
   "description": "OpenAPI specification and version history for the Lunch Money v2 API",
   "main": "lunch-money-api-v2.yaml",
   "files": [

package/version-history.md

@@ -17,6 +17,8 @@ The Lunch Money API spec uses a modified version of SEMVER for its versioning me
 - Add `PUT /balance_history/deleted/{account_id}/details`
 - Remove `rollover_pool` from the category object returned in the summary response. It is in the main summary response.
 - It is now possible to set an external_id on any transaction, including those that belong to a Plaid account.
+- Manual-account and manually managed crypto create requests now accept `null` for their optional display, institution, and subtype fields, treating `null` the same as omission.
+- Transaction split requests now accept `null` for `category_id` and `notes`. Omission inherits the parent value, while `null` explicitly clears it for the child.
 
 ## v2.10.0 - TBD
 - Add v2 crypto endpoints which support: