@lunch-money/developer-docs 2.11.1-docs.1 → 2.11.1-docs.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lunch-money/developer-docs",
3
- "version": "2.11.1-docs.1",
3
+ "version": "2.11.1-docs.2",
4
4
  "description": "Developer documentation content for Lunch Money APIs",
5
5
  "exports": {
6
6
  ".": "./package.json",
@@ -317,10 +317,10 @@ GET /v2/plaid_accounts/123
317
317
  GET /v2/tags/1
318
318
  ```
319
319
 
320
- **Migration Strategy**:
320
+ **Migration Strategy**:
321
321
  - Maintain a local cache of categories, accounts, and tags
322
- - Update your code to use IDs and fetch related objects separately when needed
323
- - Consider batching requests or using the bulk endpoints to reduce API calls
322
+ - 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`
323
+ - Refresh cached related objects when their metadata changes instead of fetching them once per transaction
324
324
 
325
325
  #### Removed Properties
326
326
 
@@ -415,14 +415,17 @@ See the [Amounts & balances guide](/amounts-and-balances) for the full sign conv
415
415
  #### Split and Grouped Transactions
416
416
 
417
417
  **Split Transactions**:
418
- - Parents of split transactions (`is_parent: true`) are not returned by default in `GET /transactions`
418
+ - Parents of split transactions (`is_split_parent: true`) are not returned by default in `GET /transactions`
419
419
  - Split transactions include `split_parent_id` pointing to the parent
420
420
  - Use `GET /transactions/:id` to get parent with full `children` array
421
421
  - Use `GET /transactions` with query param `include_split_parents=true` to include parents in list
422
422
 
423
+ > [!WARNING] Prevent duplicate split processing
424
+ > 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.
425
+
423
426
  **Grouped Transactions**:
424
427
  - Transactions that have been grouped are not returned by default
425
- - Only the group transaction (`is_group: true`) is returned
428
+ - Only the group transaction (`is_group_parent: true`) is returned
426
429
  - Use `GET /transactions/:id` to get details of grouped transactions in the transaction group's `children` array.
427
430
 
428
431
 
@@ -9457,22 +9457,21 @@ paths:
9457
9457
  minimum: 1
9458
9458
  maximum: 2000
9459
9459
  default: 1000
9460
- description: Sets the maximum number of transactions to return. If
9461
- more match the filter criteria, the response will include a
9462
- `has_more` attribute set to `true`. See
9463
- [Pagination](https://lunchmoney.dev/v2/pagination)
9460
+ description: Sets the maximum number of transactions to return.
9461
+ Defaults to `1000`. When more transactions match, `has_more` is
9462
+ `true`. See [Pagination](https://lunchmoney.dev/pagination)
9464
9463
  - name: offset
9465
9464
  in: query
9466
9465
  schema:
9467
9466
  type: integer
9468
- description: Sets the offset for the records returned. This is
9469
- typically set automatically in the header. See
9470
- [Pagination](https://lunchmoney.dev/v2/pagination)
9467
+ description: Sets the number of matching transactions to skip before
9468
+ returning results. Increase this query parameter for each page. See
9469
+ [Pagination](https://lunchmoney.dev/pagination)
9471
9470
  responses:
9472
9471
  "200":
9473
9472
  description: Returns an array of transactions. <br><br>The `has_more`
9474
9473
  property is set to `true` if more transactions are available. See
9475
- [Pagination](https://lunchmoney.dev/v2/pagination)
9474
+ [Pagination](https://lunchmoney.dev/pagination)
9476
9475
  content:
9477
9476
  application/json:
9478
9477
  schema: