@lunch-money/v2-api-spec 2.9.0 → 2.9.2

package/README.md.backup

@@ -66,18 +66,6 @@ The OpenAPI spec is the authoritative source for:
 - Authentication requirements
 - Status codes and error formats
 
-##### Versioning
-
-The Lunch Money API spec uses a modified version of SEMVER for its versioning methodology as follows
-- The major version is the API version.  This will always be 2 in this repo
-- The minor version represents the number of main endpoints (or OpenAPI tags) 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.
-
-Details of each version can be found in [./version-history.md](./version-history.md)
-
-Changes to the spec that modify existing or add new API endpoints should update the version number in the spec and in the package.json accordingly.
-
-
 ### Documentation Guides (`v2/docs/*.md`)
 - **Purpose**: Human-readable guides and tutorials
 - **Format**: Markdown with custom extensions

package/lunch-money-api-v2.yaml

@@ -42,7 +42,7 @@ info:
   license:
     name: Apache 2.0
     url: http://www.apache.org/licenses/LICENSE-2.0.html
-  version: 2.9.0
+  version: 2.9.2
 
 servers:
   - url: https://api.lunchmoney.dev/v2
@@ -561,10 +561,11 @@ components:
           x-updatable: false
         archived_at:
           type: string
+          format: date-time
           nullable: true
-          description: System set date and time of when the category was last archived (in
-            the ISO 8601 extended format). Ignored if set.
-          x-updatable: false
+          description: If set, updates the archived timestamp for the category.
+            Provide an ISO 8601 extended datetime or `null` to clear it.
+          x-updatable: true
         updated_at:
           type: string
           format: date-time
@@ -1458,8 +1459,9 @@ components:
           type: string
           format: date-time
           nullable: true
-          description: System-set time the tag was archived. Ignored if set.
-          x-updatable: false
+          description: If set, updates the archived timestamp for the tag.
+            Provide an ISO 8601 extended datetime or `null` to clear it.
+          x-updatable: true
 
     # The object returned when a DELETE /tag/:id request 
     # has an id for a tag that has dependencies  
@@ -1529,14 +1531,10 @@ components:
             Name of payee set by the user, the financial institution, or by 
             a matched recurring item. This will match the value 
             displayed in payee field on the transactions page in the GUI.
-          minLength: 0
-          maxLength: 140
         original_name:
           type: string
           nullable: true
           description: Original payee name from the source (financial institution, CSV, etc.). For Plaid transactions, this is the raw name before normalization. For manual/API transactions, this typically matches `payee`. May be null for older transactions.
-          minLength: 0
-          maxLength: 140
         category_id:
           type: integer
           format: int32
@@ -1803,14 +1801,10 @@ components:
             Name of payee set by the user, the financial institution, or by 
             a matched recurring item. This will match the value 
             displayed in payee field on the transactions page in the GUI.
-          minLength: 0
-          maxLength: 140
         original_name:
           type: string
           nullable: true
           description: Original payee name from the source (financial institution, CSV, etc.). For Plaid transactions, this is the raw name before normalization. For manual/API transactions, this typically matches `payee`. May be null for older transactions.
-          minLength: 0
-          maxLength: 140
         category_id:
           type: integer
           format: int32
@@ -2048,14 +2042,10 @@ components:
         payee:
           type: string
           description: Name of payee for the transaction
-          minLength: 0
-          maxLength: 140
         original_name:
           type: string
           nullable: true
           description: Original payee name. If not provided, defaults to `payee` value.
-          minLength: 0
-          maxLength: 140
         category_id:
           type: integer
           format: int32
@@ -2188,15 +2178,11 @@ components:
           type: string
           description: |
             The new payee for the transaction.
-          minLength: 0
-          maxLength: 140
           x-updatable: true
         original_name:
           type: string
           nullable: true
           description: Original payee name. Cannot be changed. Ignored if set.
-          minLength: 0
-          maxLength: 140
           x-updatable: false
         category_id:
           type: integer
@@ -4461,7 +4447,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no category with the id:'543210'`
+                  - errMsg: "There is no category with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -4475,7 +4461,7 @@ paths:
         
         You may submit the response from a `GET /categories/{id}` as the request body; however, only certain
         properties can be updated using this API. The following properties are
-        accepted in the request body but their values will be ignored: `id`, `is_group`,`archived_at`, `updated_at`, `created_at`, and `order`.<br><br>
+        accepted in the request body but their values will be ignored: `id`, `is_group`, `updated_at`, `created_at`, and `order`.<br><br>
 
         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 of the
@@ -4621,7 +4607,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no category with the id:'543210'`
+                  - errMsg: "There is no category with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -4676,7 +4662,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no category with the id:'543210'`
+                  - errMsg: "There is no category with the id: 543210."
         "422":
           description: Unprocessable Entity
           content:
@@ -5139,7 +5125,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no manual account with the id:'543210'`
+                  - errMsg: "There is no manual account with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -5196,7 +5182,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no manual account with the id:'543210'`
+                  - errMsg: "There is no manual account with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -6358,7 +6344,7 @@ paths:
               examples:
                 invalid ids in new transactions:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
                       - errMsg: "transactions[0] manual account ID does not exist: 9999999"
                         transaction_index: 0
@@ -6377,7 +6363,7 @@ paths:
                         recurring_id: 88888888
                 duplicate external_ids within request:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
                       - errMsg: Duplicate External IDs found in the request body
                         error: Duplicate External ID
@@ -6653,7 +6639,7 @@ paths:
               examples:
                 invalid ids in id list:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
                       - errMsg: "transactions[0] manual account ID does not exist: 999999999"
                         transaction_index: 0
@@ -6672,7 +6658,7 @@ paths:
                         recurring_id: 888888888
                 update with errors:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
                       - errMsg: "There is no transaction with the id: 9999999"
                         error: Invalid Transaction ID
@@ -6730,7 +6716,7 @@ paths:
                         locked_property: amount
                 duplicate external_ids within request:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
                       - errMsg: Duplicate External IDs found in the request body
                         error: Duplicate External ID
@@ -6748,7 +6734,7 @@ paths:
                           - 3
                 invalid ids:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
                       - errMsg: "There is no transaction with the id: 1"
                         error: Invalid Transaction ID
@@ -7117,7 +7103,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no transaction with the id:'543210'`
+                  - errMsg: "There is no transaction with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -7256,7 +7242,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no transaction with the id:'543210'`
+                  - errMsg: "There is no transaction with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -7309,7 +7295,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no transaction with the id:'543210'`
+                  - errMsg: "There is no transaction with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -7830,30 +7816,30 @@ paths:
               examples:
                 bad math:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
-                      - errMsg: Sums of split transactions do not add up to the original transaction
-                          amount!
+                      - errMsg: Sum of split transactions do not add up to the original transaction amount.
                 split recurring:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
-                      - errMsg: You cannot split a recurring transaction!
+                      - errMsg: You cannot split a recurring transaction.
+                        id: 2112150655
                 split group:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
-                      - errMsg: You cannot split a grouped transaction!
+                      - errMsg: You cannot split a group transaction. Ungroup it before splitting.
                 split split:
                   value:
-                    message: Invalid Request Body
+                    message: Request Validation Failure
                     errors:
-                      - errMsg: You cannot split an already split transaction!"
+                      - errMsg: You cannot split an already split transaction. Unsplit it before splitting again.
                 missing amount in child transaction:
                   value:
                     message: Invalid Request Body
                     errors:
-                      - errMsg: "child_transactions[0] amount is required."
+                      - errMsg: "child_transactions[0] is missing required property 'amount' in request body."
                         child_transactions_index: 0
                         error: Missing required property
                         invalid_property: amount
@@ -8327,7 +8313,7 @@ paths:
         
         You may submit the response from a `GET /tags/{id}` as the request body, however only certain
         properties can be updated using this API. The following system set properties are
-        accepted in the request body but their values will be ignored: `id`, `updated_at`, `created_at`, and `archived_at`.<br><br>
+        accepted in the request body but their values will be ignored: `id`, `updated_at`, and `created_at`.<br><br>
 
         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 of the
@@ -8407,9 +8393,9 @@ paths:
               schema:
                 $ref: "#/components/schemas/errorResponseObject"
               example:
-                message: Invalid Request Body
+                message: Request Validation Failure
                 errors:
-                  - errMsg: "A request to update a tag must include at least one of the following properties: name, description, archived"
+                  - errMsg: "A request to update a tag must include at least one of the following properties: name, description, archived."
         "401":
           $ref: "#/components/responses/unauthorizedToken"
         "404":
@@ -8421,7 +8407,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no tag with the id:'543210'`
+                  - errMsg: "There is no tag with the id: 543210."
         "429":
           $ref: "#/components/responses/rateLimited"
         "500":
@@ -8476,7 +8462,7 @@ paths:
               example:
                 message: Not Found
                 errors:
-                  - errMsg: There is no tag with the id:'543210'`
+                  - errMsg: "There is no tag with the id: 543210."
         "422":
           description: Unprocessable Entity
           content:

package/package.json

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

package/version-history.md

@@ -5,6 +5,12 @@ 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.9.2 - Apr 22, 2026
+- Increase allowable length for a transaction `payee`
+
+## v2.9.1 - Apr 22, 2026
+- You may now set `archived_at` when modifying a category or tag via the `PUT /categories` or `PUT /tags` endpoints.
+
 ## v2.9.0 - Feb 26, 2026
 - Add initial `/budgets` endpoint support:
   - `GET /budgets/settings` for account budget settings
@@ -146,7 +152,7 @@ The Lunch Money API spec uses a modified version of SEMVER for its versioning me
     - It is also now permissible to include strings in the `children` property.  These will be used as the names of new child categories that will be created.
 - This release also updates the following schemas:
   - Correctly specifies that all properties of the manualAccountObject are required
-  - Updates the updateManualAccountRequestObject and updatePlaidManualAccountRequest object to allow the `balance` property to be either a string or a number.
+  - Updates the updateManualAccountObject and updatePlaidManualAccountObject to allow the `balance` property to be either a string or a number.
   - Updates the userObject to include the `debits_as_negative` property.  The documentation for Transaction Objects returned by GET requests have been updated to reflect how/if this setting affects the `amount` property of the transaction.
   - Updates the childCategoryObject to restore the `exclude_from_budget`, `exclude_from_totals` and `is_income` properties.  These properties are inherited from the Category Group and not settable but are provided for convenience.
 
@@ -346,4 +352,3 @@ This is the initial branch using the versioning described above
 - It is the v2 version of the API - hence the major version 2.
 - The API Spec currently supports 3 endpoints /me, /categories, and /transactions.  hence the minor version 3.
 - This version of the spec contains minor modifications to the previously published spec and therefore has a revision number 1
-