@lunch-money/developer-docs 2.11.0-preview.10

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/v1/_user.md ADDED
@@ -0,0 +1,39 @@
1
+ # User
2
+
3
+ <aside class="notice">
4
+ This API (v1) will not progress to a generally available state. For new projects, we recommend using the <a href="/v2/docs#tag/me">v2 API</a>, which is in open alpha and actively maintained.
5
+ </aside>
6
+
7
+ ## User Object
8
+
9
+ | Attribute Name | Type | Nullable | Description |
10
+ | -------------- | ------ | -------- | --------------------------------------------------------------------------------------- |
11
+ | user_id | number | false | Unique identifier for user |
12
+ | user_name | string | false | User's name |
13
+ | user_email | string | false | User's email |
14
+ | account_id | number | false | Unique identifier for the associated budgeting account |
15
+ | budget_name | string | false | Name of the associated budgeting account |
16
+ | primary_currency|string | false | Primary currency from user's settings |
17
+ | api_key_label | string | true | User-defined label of the developer API key used. Returns null if nothing has been set. |
18
+
19
+ ## Get User
20
+
21
+ Use this endpoint to get details on the current user.
22
+
23
+ ```json
24
+ {
25
+ "user_name": "User 1",
26
+ "user_email": "user-1@lunchmoney.dev",
27
+ "user_id": 18328,
28
+ "account_id": 18221,
29
+ "budget_name": "🏠 Family budget",
30
+ "primary_currency": "usd",
31
+ "api_key_label": "Side project dev key"
32
+ }
33
+ ```
34
+
35
+ ### HTTP Request
36
+
37
+ `GET https://api.lunchmoney.dev/v1/me`
38
+
39
+ ---
@@ -0,0 +1,506 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>Lunch Money API Visual Changelog</title>
7
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css">
8
+ <style>
9
+ .new { color: green; }
10
+ .deleted { color: red; }
11
+ .renamed { color: orange; }
12
+ .moved { color: blueviolet; }
13
+ </style>
14
+ </head>
15
+ <body>
16
+ <div class="container">
17
+ <h1 style="text-align: center;">Lunch Money v2 API <br> Object Changes</h1>
18
+ <table class="table table-bordered">
19
+ <tbody>
20
+ <tr>
21
+ <td id="user-object-row"></td>
22
+ <td><a href="https://lunchmoney.dev/#user-object" target="_blank">v1 User Object</a></td>
23
+ <td><a href="/v2/docs#model/userObject">v2 User Object</a></td>
24
+ </tr>
25
+ <tr>
26
+ <td>
27
+ <a href="changelog#the-user-object">
28
+ User<br>Object<br>Changelog
29
+ </a>
30
+ </td>
31
+ <td>
32
+ <ul>
33
+ <li class="renamed">user_name (renamed)</li>
34
+ <li class="renamed">user_email (renamed)</li>
35
+ <li class="renamed">user_id (renamed)</li>
36
+ <li>account_id</li>
37
+ <li>budget_name</li>
38
+ <li>primary_currency</li>
39
+ <li>api_key_label</li>
40
+ </ul>
41
+ </td>
42
+ <td>
43
+ <ul>
44
+ <li class="renamed">name (renamed)</li>
45
+ <li class="renamed">email (renamed)</li>
46
+ <li class="renamed">id (renamed)</li>
47
+ <li>account_id</li>
48
+ <li>budget_name</li>
49
+ <li>primary_currency</li>
50
+ <li>api_key_label</li>
51
+ <li class="new">debits_as_negative (new)</li>
52
+ </ul>
53
+ </td>
54
+ </tr>
55
+ <tr>
56
+ <td id="category-object-row"></td>
57
+ <td><a href="https://lunchmoney.dev/#categories-object" target="_blank">v1 Category Object</a></td>
58
+ <td><a href="/v2/docs#model/categoryObject">v2 Category Object</a></td>
59
+ </tr>
60
+ <tr>
61
+ <td>
62
+ <a href="changelog#the-category-object">
63
+ Category<br>Object<br>Changelog
64
+ </a>
65
+ </td>
66
+ <td>
67
+ <ul>
68
+ <li>id</li>
69
+ <li>name</li>
70
+ <li>description</li>
71
+ <li>is_income</li>
72
+ <li>exclude_from_budget</li>
73
+ <li>exclude_from_totals</li>
74
+ <li>created_at</li>
75
+ <li>updated_at</li>
76
+ <li>is_group</li>
77
+ <li>group_id</li>
78
+ <li class="deleted">group_category_name (deleted)</li>
79
+ <li>children</li>
80
+ <li>order</li>
81
+ <li></li>
82
+ <li>archived</li>
83
+ <li class="renamed">archived_on (renamed)</li>
84
+ </ul>
85
+ </td>
86
+ <td>
87
+ <ul>
88
+ <li>id</li>
89
+ <li>name</li>
90
+ <li>description</li>
91
+ <li>is_income</li>
92
+ <li>exclude_from_budget</li>
93
+ <li>exclude_from_totals</li>
94
+ <li>created_at</li>
95
+ <li>updated_at</li>
96
+ <li>is_group</li>
97
+ <li>group_id</li>
98
+ <li></li>
99
+ <li>children (only when is_group is true)</li>
100
+ <li>order</li>
101
+ <li class="new">collapsed (new)</li>
102
+ <li>archived</li>
103
+ <li class="renamed">archived_at (renamed)</li>
104
+ </ul>
105
+ </td>
106
+ </tr>
107
+ <tr>
108
+ <td id="tags-object-row"></td>
109
+ <td><a href="https://lunchmoney.dev/#tags" target="_blank">v1 Tag Object</a></td>
110
+ <td><a href="/v2/docs#model/tagObject">v2 Tag Object</a></td>
111
+ </tr>
112
+ <tr>
113
+ <td>
114
+ <a href="changelog#the-tags-object">
115
+ Tag<br>Object<br>Changelog
116
+ </td>
117
+ <td>
118
+ <ul>
119
+ <li>id</li>
120
+ <li>name</li>
121
+ <li>description</li>
122
+ <li></li>
123
+ <li></li>
124
+ <li>archived</li>
125
+ <li></li>
126
+ </ul>
127
+ </td>
128
+ <td>
129
+ <ul>
130
+ <li>id</li>
131
+ <li>name</li>
132
+ <li>description</li>
133
+ <li class="new">updated_at (new)</li>
134
+ <li class="new">created_at (new)</li>
135
+ <li>archived</li>
136
+ <li class="new">archived_at (new)</li>
137
+ </ul>
138
+ </td>
139
+ </tr>
140
+ <tr>
141
+ <td id="transaction-object-row"></td>
142
+ <td><a href="https://lunchmoney.dev/#transaction-object" target="_blank">v1 Transaction Object</a></td>
143
+ <td><a href="/v2/docs#model/transactionObject">v2 Transaction Object</a></td>
144
+ </tr>
145
+ <tr>
146
+ <td>
147
+ <a href="changelog#the-transaction-object">
148
+ Transaction<br>Object<br>Changelog
149
+ </a>
150
+ </td>
151
+ <td>
152
+ <ul>
153
+ <li>id</li>
154
+ <li>date</li>
155
+ <li>amount</li>
156
+ <li>currency</li>
157
+ <li>to_base</li>
158
+ <li>recurring_id</li>
159
+ <li></li>
160
+ <li></li>
161
+ <li></li>
162
+ <li>payee</li>
163
+ <li>category_id</li>
164
+ <li>notes</li>
165
+ <li>status</li>
166
+ <li>is_pending</li>
167
+ <li>created_at</li>
168
+ <li>updated_at</li>
169
+ <li>parent_id</li>
170
+ <li class="deleted">has_children (deleted)</li>
171
+ <li>children</li>
172
+ <li>is_group</li>
173
+ <li>group_id</li>
174
+ <li class="renamed">asset_id (renamed)</li>
175
+ <li>plaid_account_id</li>
176
+ <li class="deleted">tags (deleted)</li>
177
+ <li>source</li>
178
+ <li>external_id</li>
179
+ <li>plaid_metadata</li>
180
+ <li class="deleted">original_name (deleted)</li>
181
+ <li class="deleted">display_name (deleted)</li>
182
+ <li class="deleted">display_notes (deleted)</li>
183
+ <li class="deleted">recurring_payee (deleted)</li>
184
+ <li class="deleted">recurring_description (deleted)</li>
185
+ <li class="deleted">recurring_cadence (deleted)</li>
186
+ <li class="deleted">recurring_type (deleted)</li>
187
+ <li class="deleted">recurring_amount (deleted)</li>
188
+ <li class="deleted">recurring_currency (deleted)</li>
189
+ <li class="deleted">recurring_granularity (deleted)</li>
190
+ <li class="deleted">recurring_quantity (deleted)</li>
191
+ <li class="deleted">category_name (deleted)</li>
192
+ <li class="deleted">category_group_id (deleted)</li>
193
+ <li class="deleted">category_group_name (deleted)</li>
194
+ <li class="deleted">is_income (deleted)</li>
195
+ <li class="deleted">exclude_from_budget (deleted)</li>
196
+ <li class="deleted">exclude_from_totals (deleted)</li>
197
+ <li class="deleted">asset_institution_name (deleted)</li>
198
+ <li class="deleted">asset_name (deleted)</li>
199
+ <li class="deleted">asset_display_name (deleted)</li>
200
+ <li class="deleted">asset_status (deleted)</li>
201
+ <li class="deleted">plaid_account_id (deleted)</li>
202
+ <li class="deleted">plaid_account_name (deleted)</li>
203
+ <li class="deleted">plaid_account_mask (deleted)</li>
204
+ <li class="deleted">institution_name (deleted)</li>
205
+ <li class="deleted">plaid_account_display_name (deleted)</li>
206
+ <li class="deleted">account_display_name (deleted)</li>
207
+ </ul>
208
+ </td>
209
+ <td>
210
+ <ul>
211
+ <li>id</li>
212
+ <li>date</li>
213
+ <li>amount</li>
214
+ <li>currency</li>
215
+ <li>to_base</li>
216
+ <li>recurring_id</li>
217
+ <li class="new">overrides (new)
218
+ <ul>
219
+ <li>original_payee</li>
220
+ <li>original_notes</li>
221
+ </ul>
222
+ </li>
223
+ <li>payee</li>
224
+ <li>category_id</li>
225
+ <li>notes</li>
226
+ <li>status</li>
227
+ <li>is_pending</li>
228
+ <li>created_at</li>
229
+ <li>updated_at</li>
230
+ <li class="renamed">split_parent_id (renamed)</li>
231
+ <li class="new">is_parent (new)</li>
232
+ <li>children</li>
233
+ <li class="renamed">is_group_parent (renamed)</li>
234
+ <li class="renamed">group_parent_id (renamed)</li>
235
+ <li class="renamed">manual_account_id (renamed)</li>
236
+ <li>plaid_account_id</li>
237
+ <li class="new">tag_ids (new)</li>
238
+ <li>source</li>
239
+ <li>external_id</li>
240
+ <li>plaid_metadata</li>
241
+ <li class="new">custom_metadata (new)</li>
242
+ <li class="new">files (new)</li>
243
+ </ul>
244
+ </td>
245
+ </tr>
246
+ <tr>
247
+ <td id="manual-account-object-row"></td>
248
+ <td><a href="https://lunchmoney.dev/#assets" target="_blank">v1 Asset Object</a></td>
249
+ <td><a href="/v2/docs#model/manualAccountObject">v2 Manual Account Object</a></td>
250
+ </tr>
251
+ <tr>
252
+ <td>
253
+
254
+ <a href="changelog#the-manual-account-object-formerly-asset-object-">
255
+ Manual<br>Account<br>Object<br>Changelog
256
+ </a>
257
+ </td>
258
+ <td>
259
+ <ul>
260
+ <li>id</li>
261
+ <li>name</li>
262
+ <li class="renamed">type_name (renamed)</li>
263
+ <li class="renamed">subtype_name (renamed)</li>
264
+ <li>display_name</li>
265
+ <li>balance</li>
266
+ <li>currency</li>
267
+ <li>to_base</li>
268
+ <li>balance_as_of</li>
269
+ <li>institution_name</li>
270
+ <li></li>
271
+ <li></li>
272
+ <li class="renamed">exclude_transactions (renamed)</li>
273
+ <li>closed_on</li>
274
+ <li>created_at</li>
275
+ <li></li>
276
+ </ul>
277
+ </td>
278
+ <td>
279
+ <ul>
280
+ <li>id</li>
281
+ <li>name</li>
282
+ <li class="renamed">type (renamed)</li>
283
+ <li class="renamed">subtype (renamed)</li>
284
+ <li>display_name</li>
285
+ <li>balance</li>
286
+ <li>currency</li>
287
+ <li>to_base</li>
288
+ <li>balance_as_of</li>
289
+ <li>institution_name</li>
290
+ <li class="new">external_id (new) </li>
291
+ <li class="new">custom_metadata (new)</li>
292
+ <li class="renamed">exclude_from_transactions (renamed)</li>
293
+ <li>closed_on</li>
294
+ <li>created_at</li>
295
+ <li class="new">updated_at (new)</li>
296
+ </ul>
297
+ </td>
298
+ </tr>
299
+ <tr>
300
+ <td id="plaid-account-object-row"></td>
301
+ <td><a href="https://lunchmoney.dev/#plaid-accounts-object" target="_blank">v1 Plaid Account Object</a></td>
302
+ <td><a href="/v2/docs#model/plaidAccountObject">v2 Plaid Account Object</a></td>
303
+ </tr>
304
+ <tr>
305
+ <td>
306
+ <a href="changelog#the-plaid-account-object">
307
+ Plaid<br>Account<br>Object<br>Changelog
308
+ </td>
309
+ <td>
310
+ <ul>
311
+ <li>id</li>
312
+ <li>date_linked</li>
313
+ <li>name</li>
314
+ <li>display_name</li>
315
+ <li>type</li>
316
+ <li>subtype</li>
317
+ <li>mask</li>
318
+ <li>institution_name</li>
319
+ <li>status</li>
320
+ <li></li>
321
+ <li>limit</li>
322
+ <li>balance</li>
323
+ <li>currency</li>
324
+ <li>to_base</li>
325
+ <li>balance_last_update</li>
326
+ <li>import_start_date</li>
327
+ <li>last_import</li>
328
+ <li>last_fetch</li>
329
+ <li>plaid_last_successful_update</li>
330
+ </ul>
331
+ </td>
332
+ <td>
333
+ <ul>
334
+ <li>id</li>
335
+ <li>date_linked</li>
336
+ <li>name</li>
337
+ <li>display_name</li>
338
+ <li >type</li>
339
+ <li>subtype</li>
340
+ <li>mask</li>
341
+ <li>institution_name</li>
342
+ <li>status</li>
343
+ <li class="new">allow_transaction_modifications (new) </li>
344
+ <li>limit</li>
345
+ <li>balance</li>
346
+ <li>currency</li>
347
+ <li>to_base</li>
348
+ <li>balance_last_update</li>
349
+ <li>import_start_date</li>
350
+ <li>last_import</li>
351
+ <li>last_fetch</li>
352
+ <li>plaid_last_successful_update</li>
353
+ </ul>
354
+ </td>
355
+ </tr>
356
+ <tr>
357
+ <td id="crypto-object-row"></td>
358
+ <td><a href="https://lunchmoney.dev/#crypto-object" target="_blank">v1 ManualCrypto Object</a></td>
359
+ <td><a href="/v2/docs#tag/crypto-manual">v2 Manual Crypto Object</a></td>
360
+ </tr>
361
+ <tr>
362
+ <td>
363
+ <a href="./changelog#the-crypto-balance-object">
364
+ Crypto<br>Object<br>Changelog
365
+ </a>
366
+ </td>
367
+ <td>
368
+ <ul>
369
+ <li>id</li>
370
+ <li>source</li>
371
+ <li>name</li>
372
+ <li>display_name</li>
373
+ <li>institution_name</li>
374
+ <li>balance</li>
375
+ <li>currency</li>
376
+ <li>coingecko_id</li>
377
+ <li>to_base</li>
378
+ <li>balance_as_of</li>
379
+ <li>status</li>
380
+ <li>created_at</li>
381
+ <li></li>
382
+ <li></li>
383
+ </ul>
384
+ </td>
385
+ <td>
386
+ <ul>
387
+ <li>id</li>
388
+ <li>source</li>
389
+ <li>name</li>
390
+ <li>display_name</li>
391
+ <li>institution_name</li>
392
+ <li>balance</li>
393
+ <li class="renamed">symbol (renamed from currency)</li>
394
+ <li>coingecko_id</li>
395
+ <li>to_base</li>
396
+ <li>balance_as_of</li>
397
+ <li></li>
398
+ <li>created_at</li>
399
+ <li class="new">updated_at (new)</li>
400
+ <li class="new">created_by_name (new)</li>
401
+ </ul>
402
+ </td>
403
+ </tr>
404
+ <tr>
405
+ <td id="recurring-object-row"></td>
406
+ <td><a href="https://lunchmoney.dev/#recurring-items-object" target="_blank">v1 Recurring Item Object</a></td>
407
+ <td><a href="/v2/docs#model/recurringObject">v2 Recurring Object</a></td>
408
+ </tr>
409
+ <tr>
410
+ <td>
411
+ <a href="changelog#the-recurring-object">
412
+ Recurring<br>Object<br>Changelog
413
+ </a>
414
+ </td>
415
+ <td>
416
+ <ul>
417
+ <li>id</li>
418
+ <li>description</li>
419
+ <li></li>
420
+ <li></li>
421
+ <li class="moved">start_date (moved)</li>
422
+ <li class="moved">end_date (moved)</li>
423
+ <li class="moved">granularity (moved)</li>
424
+ <li class="moved">quantity (moved)</li>
425
+ <li class="renamed">billing_date (renamed)</li>
426
+ <li class="renamed">original_name (renamed)</li>
427
+ <li class="moved">amount (moved)</li>
428
+ <li class="moved">currency (moved)</li>
429
+ <li class="moved">to_base (moved)</li>
430
+ <li class="moved">plaid_account_id (moved)</li>
431
+ <li class="renamed">asset_id (renamed)</li>
432
+ <li></li>
433
+ <li class="moved">payee (moved)</li>
434
+ <li class="moved">notes (moved)</li>
435
+ <li class="moved">category_id (moved)</li>
436
+ <li class="deleted">category_group_id (deleted)</li>
437
+ <li class="deleted">is_income (deleted)</li>
438
+ <li class="deleted">exclude_from_totals (deleted)</li>
439
+ <li class="renamed">date</li>
440
+ <li></li>
441
+ <li class="renamed">occurrences</li>
442
+ <li class="renamed">transactions_within_range</li>
443
+ <li class="renamed">missing_dates_within_range</li>
444
+ <li>created_by</li>
445
+ <li>created_at</li>
446
+ <li>updated_at</li>
447
+ <li>source</li>
448
+ </ul>
449
+ </td>
450
+ <td>
451
+ <ul>
452
+ <li>id</li>
453
+ <li>description</li>
454
+ <li class="new">status (new)</li>
455
+ <li class="new">transaction_criteria (new)
456
+ <ul>
457
+ <li class="moved">start_date (moved)</li>
458
+ <li class="moved">end_date (moved)</li>
459
+ <li class="moved">granularity (moved)</li>
460
+ <li class="moved">quantity (moved)</li>
461
+ <li class="renamed">anchor_date (renamed)</li>
462
+ <li class="renamed">payee (renamed)</li>
463
+ <li class="moved">amount (moved)</li>
464
+ <li class="moved">currency (moved)</li>
465
+ <li class="moved">to_base (moved)</li>
466
+ <li class="moved">plaid_account_id (moved)</li>
467
+ <li class="renamed">manual_account_id (renamed)</li>
468
+ </ul>
469
+ </li>
470
+ <li class="new">overrides (new)
471
+ <ul>
472
+ <li class="moved">payee (moved)</li>
473
+ <li class="moved">notes (moved)</li>
474
+ <li class="moved">category_id (moved)</li>
475
+ </ul>
476
+ </li>
477
+ <li></li>
478
+ <li></li>
479
+ <li class="new">matches (new)
480
+ <ul>
481
+ <li class="new">request_start_date (new)</li>
482
+ <li class="new">request_end_date (new)</li>
483
+ <li class="renamed">expected_occurrence_dates</li>
484
+ <li class="renamed">found_transactions</li>
485
+ <li class="renamed">missing_transaction_dates</li>
486
+ </ul>
487
+ </li>
488
+ <li>created_by</li>
489
+ <li>created_at</li>
490
+ <li>updated_at</li>
491
+ <li>source</li>
492
+ </ul>
493
+ </td>
494
+ </tr>
495
+ </tbody>
496
+ </table>
497
+ </div>
498
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
499
+ <script src="https://cdn.datatables.net/1.10.21/js/jquery.dataTables.min.js"></script>
500
+ <script>
501
+ $(document).ready(function() {
502
+ $('table').DataTable();
503
+ });
504
+ </script>
505
+ </body>
506
+ </html>