@lunch-money/v2-api-spec 2.8.4 → 2.8.5

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.
@@ -42,12 +42,13 @@ info:
42
42
  license:
43
43
  name: Apache 2.0
44
44
  url: http://www.apache.org/licenses/LICENSE-2.0.html
45
- version: 2.8.4
45
+ version: 2.8.5
46
46
 
47
47
  servers:
48
48
  - url: https://api.lunchmoney.dev/v2
49
49
  description: v2 Lunch Money API Server - modifies real data!
50
- - url: https://mock.lunchmoney.dev/v2
50
+ # - url: https://mock.lunchmoney.dev/v2
51
+ - url: https://alpha.lunchmoney.dev/v2
51
52
  description: Static Mock v2 Lunch Money API Server
52
53
 
53
54
  tags:
@@ -156,17 +157,17 @@ components:
156
157
  type: integer
157
158
  format: int32
158
159
  nullable: false
159
- description: A system defined unique identifier for the category.
160
+ description: A system defined unique identifier for the category
160
161
  name:
161
162
  type: string
162
163
  nullable: false
163
- description: The name of the category.
164
+ description: The name of the category
164
165
  minLength: 1
165
166
  maxLength: 100
166
167
  description:
167
168
  type: string
168
169
  nullable: true
169
- description: The description of the category or `null` if not set.
170
+ description: The description of the category or `null` if not set
170
171
  maxLength: 200
171
172
  is_income:
172
173
  type: boolean
@@ -203,7 +204,7 @@ components:
203
204
  group.
204
205
  is_group:
205
206
  type: boolean
206
- description: If `true`, the category is created as a category group.
207
+ description: If `true`, the category is created as a category group
207
208
  children:
208
209
  type: array
209
210
  items:
@@ -238,7 +239,7 @@ components:
238
239
  type: boolean
239
240
  nullable: false
240
241
  default: false
241
- description: If `true`, the category is collapsed in the Lunch Money GUI.
242
+ description: If `true`, the category is collapsed in the Lunch Money GUI
242
243
  required:
243
244
  - id
244
245
  - name
@@ -267,17 +268,17 @@ components:
267
268
  type: integer
268
269
  format: int32
269
270
  nullable: false
270
- description: A system defined unique identifier for the category.
271
+ description: A system defined unique identifier for the category
271
272
  name:
272
273
  type: string
273
274
  nullable: false
274
- description: The name of the category.
275
+ description: The name of the category
275
276
  minLength: 1
276
277
  maxLength: 100
277
278
  description:
278
279
  type: string
279
280
  nullable: true
280
- description: The description of the category or `null` if not set.
281
+ description: The description of the category or `null` if not set
281
282
  maxLength: 200
282
283
  is_income:
283
284
  type: boolean
@@ -317,7 +318,7 @@ components:
317
318
  type: boolean
318
319
  enum:
319
320
  - false
320
- description: Will always be false for a category that is part of category group.
321
+ description: Will always be false for a category that is part of category group
321
322
  archived:
322
323
  type: boolean
323
324
  description: If true, the category is archived and not displayed in relevant
@@ -338,8 +339,8 @@ components:
338
339
  API.
339
340
  collapsed:
340
341
  type: boolean
341
- nullable: true
342
- description: If `true`, the category is collapsed in the Lunch Money GUI.
342
+ nullable: false
343
+ description: Always `false` for a child category. Child categories cannot be collapsed.
343
344
  required:
344
345
  - id
345
346
  - name
@@ -354,6 +355,7 @@ components:
354
355
  - archived
355
356
  - archived_at
356
357
  - order
358
+ - collapsed
357
359
 
358
360
  # The request object for POST /categories
359
361
  # Prevent user from submitting any system created fields in a POST request
@@ -401,7 +403,7 @@ components:
401
403
  type: boolean
402
404
  nullable: false
403
405
  default: false
404
- description: If `true`, the category is created as a category group.
406
+ description: If `true`, the category is created as a category group
405
407
  group_id:
406
408
  type: integer
407
409
  format: int64
@@ -447,7 +449,8 @@ components:
447
449
  collapsed:
448
450
  type: boolean
449
451
  nullable: true
450
- description: If `true`, the category is collapsed in the Lunch Money GUI.<br>While this property can be set via the API it is generally set by the user in the Lunch Money GUI.
452
+ description: >-
453
+ If `true`, the category group is collapsed in the Lunch Money GUI. This property can only be set to `true` for category groups (`is_group: true`). While this property can be set via the API, it is generally set by the user in the Lunch Money GUI.
451
454
  required:
452
455
  - name
453
456
 
@@ -492,7 +495,7 @@ components:
492
495
  x-updatable: true
493
496
  archived:
494
497
  type: boolean
495
- description: If set, will indicate if this category is archived.
498
+ description: If set, will indicate if this category is archived
496
499
  x-updatable: true
497
500
  group_id:
498
501
  type: integer
@@ -545,12 +548,13 @@ components:
545
548
  collapsed:
546
549
  type: boolean
547
550
  nullable: true
548
- description: If `true`, the category is collapsed in the Lunch Money GUI.<br>While this property can be set via the API it is generally set by the user in the Lunch Money GUI.
551
+ description: >-
552
+ If `true`, the category group is collapsed in the Lunch Money GUI. This property can only be set to `true` for category groups (`is_group: true`). While this property can be set via the API, it is generally set by the user in the Lunch Money GUI.
549
553
  x-updatable: true
550
554
  id:
551
555
  type: integer
552
556
  format: int64
553
- description: System defined unique identifier for the category. Ignored if set.
557
+ description: System defined unique identifier for the category. Ignored if set
554
558
  x-updatable: false
555
559
  archived_at:
556
560
  type: string
@@ -660,6 +664,12 @@ components:
660
664
  displayed in payee field on the transactions page in the GUI.
661
665
  minLength: 0
662
666
  maxLength: 140
667
+ original_name:
668
+ type: string
669
+ nullable: true
670
+ 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.
671
+ minLength: 0
672
+ maxLength: 140
663
673
  category_id:
664
674
  type: integer
665
675
  format: int32
@@ -817,7 +827,7 @@ components:
817
827
  files:
818
828
  type: array
819
829
  nullable: false
820
- description: A list of objects that describe any attachments to the Transactions.
830
+ description: A list of objects that describe any attachments to the Transactions
821
831
  This is only present when the `include_files` query parameter is set to true.
822
832
  items:
823
833
  $ref: "#/components/schemas/transactionAttachmentObject"
@@ -902,7 +912,7 @@ components:
902
912
  amount:
903
913
  type: string
904
914
  description: Amount of the transaction in numeric format to 4 decimal places.
905
- Positive values indicate a debit transaction, negative values indicate a credit transaction.
915
+ Positive values indicate a debit transaction, negative values indicate a credit transaction
906
916
  currency:
907
917
  description: Three-letter lowercase currency code of the transaction in ISO 4217
908
918
  format
@@ -928,6 +938,12 @@ components:
928
938
  displayed in payee field on the transactions page in the GUI.
929
939
  minLength: 0
930
940
  maxLength: 140
941
+ original_name:
942
+ type: string
943
+ nullable: true
944
+ 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.
945
+ minLength: 0
946
+ maxLength: 140
931
947
  category_id:
932
948
  type: integer
933
949
  format: int32
@@ -1164,7 +1180,13 @@ components:
1164
1180
  - $ref: "#/components/schemas/currencyEnum"
1165
1181
  payee:
1166
1182
  type: string
1167
- description: Name of payee for the transaction.
1183
+ description: Name of payee for the transaction
1184
+ minLength: 0
1185
+ maxLength: 140
1186
+ original_name:
1187
+ type: string
1188
+ nullable: true
1189
+ description: Original payee name. If not provided, defaults to `payee` value.
1168
1190
  minLength: 0
1169
1191
  maxLength: 140
1170
1192
  category_id:
@@ -1187,7 +1209,7 @@ components:
1187
1209
  type: integer
1188
1210
  format: int32
1189
1211
  nullable: true
1190
- description: The Unique identifier for the associated manually managed account.
1212
+ description: The unique identifier for the associated manually managed account
1191
1213
  If set, this must match an existing manual account id associated
1192
1214
  with the user's account. If not set, and `plaid_account_id` is also
1193
1215
  not set, no account is associated with the transaction and it will
@@ -1260,7 +1282,7 @@ components:
1260
1282
  id:
1261
1283
  type: integer
1262
1284
  format: int64
1263
- description: System defined unique identifier of this transaction. Ignored if set.
1285
+ description: System defined unique identifier of this transaction. Ignored if set
1264
1286
  x-updatable: false
1265
1287
  date:
1266
1288
  type: string
@@ -1302,6 +1324,13 @@ components:
1302
1324
  minLength: 0
1303
1325
  maxLength: 140
1304
1326
  x-updatable: true
1327
+ original_name:
1328
+ type: string
1329
+ nullable: true
1330
+ description: Original payee name. Cannot be changed. Ignored if set.
1331
+ minLength: 0
1332
+ maxLength: 140
1333
+ x-updatable: false
1305
1334
  category_id:
1306
1335
  type: integer
1307
1336
  format: int32
@@ -1376,7 +1405,7 @@ components:
1376
1405
  custom_metadata:
1377
1406
  type: object
1378
1407
  nullable: true
1379
- description: User defined JSON data that can be set or cleared via the API.
1408
+ description: User defined JSON data that can be set or cleared via the API
1380
1409
  x-updatable: true
1381
1410
  status:
1382
1411
  type: string
@@ -1401,17 +1430,17 @@ components:
1401
1430
  x-updatable: false
1402
1431
  is_pending:
1403
1432
  type: boolean
1404
- description: System defined flag set for pending transactions. Ignored if set.
1433
+ description: System defined flag set for pending transactions. Ignored if set
1405
1434
  x-updatable: false
1406
1435
  plaid_metadata:
1407
1436
  type: object
1408
1437
  nullable: true
1409
- description: System set metadata from a Plaid account sync. Ignored if set.
1438
+ description: System set metadata from a Plaid account sync. Ignored if set
1410
1439
  x-updatable: false
1411
1440
  created_at:
1412
1441
  type: string
1413
1442
  format: date-time
1414
- description: System defined date and time of when the transaction was created.
1443
+ description: System defined date and time of when the transaction was created
1415
1444
  Ignored if set.
1416
1445
  x-updatable: false
1417
1446
  updated_at:
@@ -1422,7 +1451,7 @@ components:
1422
1451
  x-updatable: false
1423
1452
  is_split_parent:
1424
1453
  type: boolean
1425
- description: System defined boolean indicating if this transaction was split.
1454
+ description: System defined boolean indicating if this transaction was split
1426
1455
  To split or unsplit a transaction use the
1427
1456
  `/transactions/split` endpoint. Ignored if set.
1428
1457
  x-updatable: false
@@ -1506,7 +1535,7 @@ components:
1506
1535
  notes:
1507
1536
  type: string
1508
1537
  maxLength: 350
1509
- description: Will inherit notes from parent if not defined.
1538
+ description: Will inherit notes from parent if not defined
1510
1539
  required:
1511
1540
  - amount
1512
1541
 
@@ -1546,7 +1575,7 @@ components:
1546
1575
  duplicates.
1547
1576
  request_transaction:
1548
1577
  type: object
1549
- description: The requested transaction that was skipped.
1578
+ description: The requested transaction that was skipped
1550
1579
  allOf:
1551
1580
  - $ref: "#/components/schemas/insertTransactionObject"
1552
1581
 
@@ -1557,7 +1586,7 @@ components:
1557
1586
  description: The object returned from a successful POST /transactions request
1558
1587
  properties:
1559
1588
  transactions:
1560
- description: An array of the inserted transactions.
1589
+ description: An array of the inserted transactions
1561
1590
  items:
1562
1591
  $ref: "#/components/schemas/transactionObject"
1563
1592
  type: array
@@ -1618,6 +1647,16 @@ components:
1618
1647
  description: Name of the account
1619
1648
  minLength: 1
1620
1649
  maxLength: 45
1650
+ institution_name:
1651
+ type: string
1652
+ nullable: true
1653
+ minLength: 1
1654
+ maxLength: 50
1655
+ description: Name of institution holding the account
1656
+ display_name:
1657
+ type: string
1658
+ nullable: true
1659
+ description: Optional display name for the account as set by the user or derived from the `institution_name` and `name` if not explicitly set.
1621
1660
  type:
1622
1661
  description: Primary type of the account
1623
1662
  allOf:
@@ -1629,14 +1668,10 @@ components:
1629
1668
  checking - savings - prepaid credit card
1630
1669
  minLength: 1
1631
1670
  maxLength: 100
1632
- display_name:
1633
- type: string
1634
- nullable: true
1635
- description: Optional display name for the account set by the user
1636
1671
  balance:
1637
1672
  type: string
1638
1673
  pattern: ^-?\d+(\.\d{1,4})?$
1639
- description: Current balance of the account in numeric format to 4 decimal places.
1674
+ description: Current balance of the account in numeric format to 4 decimal places
1640
1675
  currency:
1641
1676
  type: string
1642
1677
  minLength: 3
@@ -1649,18 +1684,18 @@ components:
1649
1684
  type: string
1650
1685
  format: date-time
1651
1686
  description: Date balance was last updated in ISO 8601 extended format, can be in date or date-time format
1687
+ status:
1688
+ type: string
1689
+ description: The status of the account
1690
+ enum:
1691
+ - active
1692
+ - closed
1652
1693
  closed_on:
1653
1694
  type: string
1654
1695
  format: date
1655
1696
  nullable: true
1656
- description: The date this account was closed. Will be null if the account has
1657
- not been marked as closed
1658
- institution_name:
1659
- type: string
1660
- nullable: true
1661
- minLength: 1
1662
- maxLength: 50
1663
- description: Name of institution holding the account
1697
+ description: The date this account was closed in YYYY-MM-DD format. Will be null if the account has
1698
+ not been marked as closed.
1664
1699
  external_id:
1665
1700
  type: string
1666
1701
  nullable: true
@@ -1670,13 +1705,16 @@ components:
1670
1705
  custom_metadata:
1671
1706
  type: object
1672
1707
  nullable: true
1673
- description: User defined JSON data that can be set or cleared via the API.
1708
+ description: User defined JSON data that can be set or cleared via the API
1674
1709
  additionalProperties: true
1675
1710
  exclude_from_transactions:
1676
1711
  type: boolean
1677
1712
  default: false
1678
1713
  description: If true, this account will not show up as an option for assignment
1679
1714
  when creating transactions manually
1715
+ created_by_name:
1716
+ type: string
1717
+ description: The name of the user who created the account
1680
1718
  created_at:
1681
1719
  type: string
1682
1720
  format: date-time
@@ -1699,8 +1737,10 @@ components:
1699
1737
  - institution_name
1700
1738
  - external_id
1701
1739
  - exclude_from_transactions
1740
+ - created_by_name
1702
1741
  - created_at
1703
1742
  - updated_at
1743
+ - status
1704
1744
 
1705
1745
  # The object that may be submitted to POST /manual_accounts
1706
1746
  createManualAccountRequestObject:
@@ -1714,8 +1754,19 @@ components:
1714
1754
  minLength: 1
1715
1755
  maxLength: 45
1716
1756
  example: My Savings Account
1757
+ institution_name:
1758
+ type: string
1759
+ example: Bank of the West
1760
+ description: Name of institution holding the manual account
1761
+ minLength: 1
1762
+ maxLength: 50
1763
+ display_name:
1764
+ type: string
1765
+ description: Display name of the manual account as set by user or derived from the `institution_name` and `name` if not explicitly set.<br>
1766
+ This must be unique for the budgeting account.
1767
+ example: Savings
1717
1768
  type:
1718
- description: The type of manual account.
1769
+ description: The type of manual account
1719
1770
  allOf:
1720
1771
  - $ref: "#/components/schemas/accountTypeEnum"
1721
1772
  subtype:
@@ -1725,11 +1776,6 @@ components:
1725
1776
  minLength: 1
1726
1777
  maxLength: 100
1727
1778
  example: prepaid credit card
1728
- display_name:
1729
- type: string
1730
- description: Display name of the manual account as set by user.<br>
1731
- This must be unique for the budgeting account. If not set, it will be derived from the `institution_name` (if any) plus `name`.
1732
- example: Savings
1733
1779
  balance:
1734
1780
  oneOf:
1735
1781
  - type: number
@@ -1747,23 +1793,27 @@ components:
1747
1793
  - format: date
1748
1794
  example: "2024-09-15"
1749
1795
  description: Date/time the balance of the manual account was last updated in ISO 8601 extended format
1750
- closed_on:
1751
- type: string
1752
- format: date
1753
- nullable: true
1754
- example: "2024-10-01"
1755
- description: The date this manual account was closed in YYYY-MM-DD format.
1756
1796
  currency:
1757
1797
  description: Three-letter lowercase currency code of the transaction in ISO 4217
1758
1798
  format
1759
1799
  allOf:
1760
1800
  - $ref: "#/components/schemas/currencyEnum"
1761
- institution_name:
1801
+ status:
1762
1802
  type: string
1763
- example: Bank of the West
1764
- description: Name of institution holding the manual account
1765
- minLength: 1
1766
- maxLength: 50
1803
+ description: The status of the account
1804
+ enum:
1805
+ - active
1806
+ - closed
1807
+ default: active
1808
+ closed_on:
1809
+ oneOf:
1810
+ - type: string
1811
+ format: date
1812
+ - type: string
1813
+ format: date-time
1814
+ nullable: true
1815
+ example: "2024-10-01"
1816
+ description: The date this manual account was closed in YYYY-MM-DD format. If set, `status` must also be set to `closed`.
1767
1817
  external_id:
1768
1818
  type: string
1769
1819
  nullable: true
@@ -1779,7 +1829,7 @@ components:
1779
1829
  additionalProperties: true
1780
1830
  exclude_from_transactions:
1781
1831
  type: boolean
1782
- description: If `true`, transactions may not be assigned to this manual account.
1832
+ description: If `true`, transactions may not be assigned to this manual account
1783
1833
  default: false
1784
1834
  required:
1785
1835
  - name
@@ -1795,16 +1845,29 @@ components:
1795
1845
  id:
1796
1846
  type: integer
1797
1847
  format: int32
1798
- description: System defined unique identifier of this account. Ignored if set.
1848
+ description: System defined unique identifier of this account. Ignored if set
1799
1849
  x-updatable: false
1800
1850
  name:
1801
1851
  type: string
1802
- description: If set, the new name of the manual account.
1852
+ description: If set, the new name of the manual account
1803
1853
  minLength: 1
1804
1854
  maxLength: 45
1805
1855
  x-updatable: true
1856
+ institution_name:
1857
+ type: string
1858
+ nullable: true
1859
+ description: If set, the name of institution holding the account
1860
+ minLength: 1
1861
+ maxLength: 50
1862
+ x-updatable: true
1863
+ display_name:
1864
+ type: string
1865
+ nullable: true
1866
+ description: If set, the new display name for the manual account.<br>
1867
+ This must be unique for the user.
1868
+ x-updatable: true
1806
1869
  type:
1807
- description: If set, the new type of the manual account.
1870
+ description: If set, the new type of the manual account
1808
1871
  x-updatable: true
1809
1872
  allOf:
1810
1873
  - $ref: "#/components/schemas/accountTypeEnum"
@@ -1815,12 +1878,6 @@ components:
1815
1878
  minLength: 1
1816
1879
  maxLength: 100
1817
1880
  x-updatable: true
1818
- display_name:
1819
- type: string
1820
- nullable: true
1821
- description: If set, an optional display name for the manual account.<br>
1822
- This must be unique for the user. If not set, it will be derived from the `institution_name` (if any) concatenated with the `name`.
1823
- x-updatable: true
1824
1881
  balance:
1825
1882
  oneOf:
1826
1883
  - type: number
@@ -1832,6 +1889,12 @@ components:
1832
1889
  the manual account as a number or string. Do not include any special
1833
1890
  characters aside from a decimal point.
1834
1891
  x-updatable: true
1892
+ currency:
1893
+ description: If set, the new three-letter lowercase currency code of the manual account
1894
+ balance.
1895
+ x-updatable: true
1896
+ allOf:
1897
+ - $ref: "#/components/schemas/currencyEnum"
1835
1898
  balance_as_of:
1836
1899
  type: string
1837
1900
  oneOf:
@@ -1842,31 +1905,28 @@ components:
1842
1905
  This property is ignored if `balance` is not also set. If `balance` is set and this property is
1843
1906
  not set the current time is used."
1844
1907
  x-updatable: true
1845
- closed_on:
1908
+ status:
1846
1909
  type: string
1847
- format: date
1848
- nullable: true
1849
- description: If set, the date this manual account was closed in YYYY-MM-DD format.
1850
- x-updatable: true
1851
- currency:
1852
- description: If set, the new three-letter lowercase currency code of the manual account
1853
- balance.
1910
+ description: If set, the status of the manual account. If set to `closed`, the the `closed_on_date` date will be set to the current date, unless it is also set.
1911
+ enum:
1912
+ - active
1913
+ - closed
1854
1914
  x-updatable: true
1855
- allOf:
1856
- - $ref: "#/components/schemas/currencyEnum"
1857
- institution_name:
1858
- type: string
1915
+ closed_on:
1859
1916
  nullable: true
1860
- description: If set, the name of institution holding the account.
1861
- minLength: 1
1862
- maxLength: 50
1917
+ oneOf:
1918
+ - type: string
1919
+ format: date
1920
+ - type: string
1921
+ format: date-time
1922
+ description: If set, the date this manual account was closed in YYYY-MM-DD format. If updating an account that is not already closed, `status` must also be set to `closed`.
1863
1923
  x-updatable: true
1864
1924
  external_id:
1865
1925
  type: string
1866
1926
  nullable: true
1867
1927
  minLength: 0
1868
1928
  maxLength: 75
1869
- description: An optional user-defined ID for the manual account.
1929
+ description: An optional user-defined ID for the manual account
1870
1930
  x-updatable: true
1871
1931
  custom_metadata:
1872
1932
  type: object
@@ -1878,11 +1938,11 @@ components:
1878
1938
  x-updatable: true
1879
1939
  exclude_from_transactions:
1880
1940
  type: boolean
1881
- description: If set, transactions may not be assigned to this manual account.
1941
+ description: If set, transactions may not be assigned to this manual account
1882
1942
  x-updatable: true
1883
1943
  to_base:
1884
1944
  type: number
1885
- description: System defined balance converted to the user's primary currency. Ignored if set. Use `balance` to update the balance in the account.
1945
+ description: System defined balance converted to the user's primary currency. Ignored if set. Use `balance` to update the balance in the account
1886
1946
  x-updatable: false
1887
1947
  created_at:
1888
1948
  type: string
@@ -1896,6 +1956,10 @@ components:
1896
1956
  description: System defined date/time the account was created in ISO 8601
1897
1957
  extended format. Ignored if set.
1898
1958
  x-updatable: false
1959
+ created_by_name:
1960
+ type: string
1961
+ description: System defined name of the user who created the account. Ignored if set
1962
+ x-updatable: false
1899
1963
 
1900
1964
  # The object containing information about a Plaid account
1901
1965
  plaidAccountObject:
@@ -1907,10 +1971,20 @@ components:
1907
1971
  type: integer
1908
1972
  format: int32
1909
1973
  description: The unique identifier of this account
1974
+ plaid_item_id:
1975
+ type: string
1976
+ nullable: true
1977
+ minLength: 0
1978
+ maxLength: 255
1979
+ description: The unique identifier of the Plaid connection that this account belongs to. Accounts with the same plaid_item_id usually belong to the same institution.
1910
1980
  date_linked:
1911
1981
  type: string
1912
1982
  format: date
1913
1983
  description: Date account was first linked in ISO 8601 format
1984
+ linked_by_name:
1985
+ type: string
1986
+ nullable: false
1987
+ description: The name of the user who linked the account
1914
1988
  name:
1915
1989
  type: string
1916
1990
  description: Name of the account. This field is set by Plaid and cannot be
@@ -1940,20 +2014,27 @@ components:
1940
2014
  status:
1941
2015
  type: string
1942
2016
  description: "Denotes the current status of the account within Lunch Money. Must
1943
- be one of<br> - `active`: Account is active and in good state<br> -
1944
- `inactive`: Account marked inactive from user. Transaction imports and balance updates will not occur for this account.<br> - `relink`: Account
1945
- needs to be relinked with Plaid.<br> - `syncing`: Account is
1946
- awaiting first import of transactions. <br> - `not found`: Account
1947
- cannot be found with Plaid<br> - `not supported`: Account is not
1948
- supported with Plaid<br> - `error`: Account is in error with
1949
- Plaid.<br>"
2017
+ be one of<br>
2018
+ - active: Account is actively syncing transactions and/or balance<br>
2019
+ - inactive: Account marked inactive from user. Transaction imports and balance updates will not occur for this account.<br>
2020
+ - closed: Account is marked as closed<br>
2021
+ - deactivated: Account is marked deactivated during setup. The user must click `Add/Remove Accounts From This Bank` and manually re-select this account to activate it.'<br>
2022
+ - not found: Account was once linked but can no longer be found with Plaid.<br>
2023
+ - not supported: Account is not supported by Plaid.<br>
2024
+ - relink: Account (and others with the same connection) need to be relinked with Plaid.<br>
2025
+ - syncing: Account is awaiting the first import of transactions.<br>
2026
+ - revoked: Account connection has been revoked by Plaid and syncing is no longer possible. A new connection needs to be set up again.<br>
2027
+ - error: Account (and others with the same connection) is in error with Plaid and requires intervention to re-activate it.<br>"
1950
2028
  enum:
1951
2029
  - active
1952
2030
  - inactive
1953
- - relink
1954
- - syncing
2031
+ - closed
2032
+ - deactivated
1955
2033
  - not found
1956
2034
  - not supported
2035
+ - relink
2036
+ - syncing
2037
+ - revoked
1957
2038
  - error
1958
2039
  allow_transaction_modifications:
1959
2040
  type: boolean
@@ -2010,7 +2091,9 @@ components:
2010
2091
  regardless of whether any new data was available in the update.
2011
2092
  required:
2012
2093
  - id
2094
+ - plaid_item_id
2013
2095
  - date_linked
2096
+ - linked_by_name
2014
2097
  - name
2015
2098
  - display_name
2016
2099
  - type
@@ -2037,22 +2120,22 @@ components:
2037
2120
  id:
2038
2121
  type: integer
2039
2122
  format: int32
2040
- description: Unique identifier for the tag.
2123
+ description: Unique identifier for the tag
2041
2124
  name:
2042
2125
  type: string
2043
- description: Name of the tag.
2126
+ description: Name of the tag
2044
2127
  description:
2045
2128
  type: string
2046
2129
  nullable: true
2047
- description: Description of the tag.
2130
+ description: Description of the tag
2048
2131
  text_color:
2049
2132
  type: string
2050
2133
  nullable: true
2051
- description: The text color of the tag.
2134
+ description: The text color of the tag
2052
2135
  background_color:
2053
2136
  type: string
2054
2137
  nullable: true
2055
- description: The background color of the tag.
2138
+ description: The background color of the tag
2056
2139
  updated_at:
2057
2140
  type: string
2058
2141
  format: date-time
@@ -2105,16 +2188,16 @@ components:
2105
2188
  type: string
2106
2189
  nullable: true
2107
2190
  default: null
2108
- description: The description of the tag. Must not exceed 200 characters.
2191
+ description: The description of the tag. Must not exceed 200 characters
2109
2192
  maxLength: 200
2110
2193
  text_color:
2111
2194
  type: string
2112
2195
  nullable: true
2113
- description: The text color of the tag.
2196
+ description: The text color of the tag
2114
2197
  background_color:
2115
2198
  type: string
2116
2199
  nullable: true
2117
- description: The background color of the tag.
2200
+ description: The background color of the tag
2118
2201
  archived:
2119
2202
  type: boolean
2120
2203
  default: false
@@ -2147,21 +2230,21 @@ components:
2147
2230
  text_color:
2148
2231
  type: string
2149
2232
  nullable: true
2150
- description: The text color of the tag.
2233
+ description: The text color of the tag
2151
2234
  x-updatable: true
2152
2235
  background_color:
2153
2236
  type: string
2154
2237
  nullable: true
2155
- description: The background color of the tag.
2238
+ description: The background color of the tag
2156
2239
  x-updatable: true
2157
2240
  archived:
2158
2241
  type: boolean
2159
- description: If set, will indicate if this category is archived.
2242
+ description: If set, will indicate if this category is archived
2160
2243
  x-updatable: true
2161
2244
  id:
2162
2245
  type: integer
2163
2246
  format: int32
2164
- description: System-defined unique identifier for the category. Ignored if set.
2247
+ description: System-defined unique identifier for the category. Ignored if set
2165
2248
  x-updatable: false
2166
2249
  updated_at:
2167
2250
  type: string
@@ -2173,13 +2256,13 @@ components:
2173
2256
  type: string
2174
2257
  format: date-time
2175
2258
  nullable: false
2176
- description: System-set time the tag was created. Ignored if set.
2259
+ description: System-set time the tag was created. Ignored if set
2177
2260
  x-updatable: false
2178
2261
  archived_at:
2179
2262
  type: string
2180
2263
  format: date-time
2181
2264
  nullable: true
2182
- description: System-set time the tag was archived. Ignored if set.
2265
+ description: System-set time the tag was archived. Ignored if set
2183
2266
  x-updatable: false
2184
2267
 
2185
2268
  # The object returned when a DELETE /tag/:id request
@@ -2219,7 +2302,7 @@ components:
2219
2302
  description:
2220
2303
  type: string
2221
2304
  nullable: true
2222
- description: An optional description of this recurring item.
2305
+ description: An optional description of this recurring item
2223
2306
  status:
2224
2307
  type: string
2225
2308
  description: The status of this recurring item. `suggested` recurring items are
@@ -2230,7 +2313,7 @@ components:
2230
2313
  - reviewed
2231
2314
  transaction_criteria:
2232
2315
  type: object
2233
- description: The set of properties used to identify matching transactions.
2316
+ description: The set of properties used to identify matching transactions
2234
2317
  properties:
2235
2318
  start_date:
2236
2319
  type: string
@@ -2246,7 +2329,7 @@ components:
2246
2329
  transactions after start_date may be considered.
2247
2330
  granularity:
2248
2331
  type: string
2249
- description: The unit of time used to define the cadence of the recurring item.
2332
+ description: The unit of time used to define the cadence of the recurring item
2250
2333
  enum:
2251
2334
  - day
2252
2335
  - week
@@ -2254,7 +2337,7 @@ components:
2254
2337
  - year
2255
2338
  quantity:
2256
2339
  type: integer
2257
- description: The number of granularity units between each recurrence.
2340
+ description: The number of granularity units between each recurrence
2258
2341
  anchor_date:
2259
2342
  type: string
2260
2343
  format: date
@@ -2279,17 +2362,17 @@ components:
2279
2362
  currency:
2280
2363
  type: string
2281
2364
  nullable: false
2282
- description: Three-letter lowercase currency code of the recurring item.
2365
+ description: Three-letter lowercase currency code of the recurring item
2283
2366
  plaid_account_id:
2284
2367
  type: integer
2285
2368
  format: int64
2286
2369
  nullable: true
2287
- description: The Plaid account ID associated with the recurring item, if any.
2370
+ description: The Plaid account ID associated with the recurring item, if any
2288
2371
  manual_account_id:
2289
2372
  type: integer
2290
2373
  format: int64
2291
2374
  nullable: true
2292
- description: The manual account ID associated with the recurring item, if any.
2375
+ description: The manual account ID associated with the recurring item, if any
2293
2376
  required:
2294
2377
  - start_date
2295
2378
  - end_date
@@ -2304,7 +2387,7 @@ components:
2304
2387
  - manual_account_id
2305
2388
  overrides:
2306
2389
  type: object
2307
- description: The values that will be applied to matching transactions.
2390
+ description: The values that will be applied to matching transactions
2308
2391
  properties:
2309
2392
  payee:
2310
2393
  type: string
@@ -2347,17 +2430,17 @@ components:
2347
2430
  transactions is expected.
2348
2431
  found_transactions:
2349
2432
  type: array
2350
- description: A list with the dates and IDs of matching transactions.
2433
+ description: A list with the dates and IDs of matching transactions
2351
2434
  items:
2352
2435
  type: object
2353
2436
  properties:
2354
2437
  date:
2355
2438
  type: string
2356
2439
  format: date
2357
- description: The date for a matching transaction within the specified range.
2440
+ description: The date for a matching transaction within the specified range
2358
2441
  transaction_id:
2359
2442
  type: integer
2360
- description: The ID of a matching transaction within the specified range.
2443
+ description: The ID of a matching transaction within the specified range
2361
2444
  missing_transaction_dates:
2362
2445
  type: array
2363
2446
  items:
@@ -2368,17 +2451,17 @@ components:
2368
2451
  created_by:
2369
2452
  type: integer
2370
2453
  nullable: false
2371
- description: The ID of the user who created the recurring item.
2454
+ description: The ID of the user who created the recurring item
2372
2455
  created_at:
2373
2456
  type: string
2374
2457
  format: date-time
2375
2458
  nullable: false
2376
- description: Date/time the recurring item was created in ISO 8601 extended format.
2459
+ description: Date/time the recurring item was created in ISO 8601 extended format
2377
2460
  updated_at:
2378
2461
  type: string
2379
2462
  format: date-time
2380
2463
  nullable: false
2381
- description: Date/time the recurring item was updated in ISO 8601 extended format.
2464
+ description: Date/time the recurring item was updated in ISO 8601 extended format
2382
2465
  source:
2383
2466
  type: string
2384
2467
  description: >
@@ -2843,19 +2926,19 @@ components:
2843
2926
  x-internal: true # Don't display in schemas section of docs
2844
2927
  properties:
2845
2928
  other_activity:
2846
- description: Total amount, in the user's default currency, of non recurring activity for the given date range.
2929
+ description: Total amount, in the user's default currency, of non recurring activity for the given date range
2847
2930
  type: number
2848
2931
  recurring_activity:
2849
- description: Total amount, in the user's default currency, of recurring activity that has occurred for the given date range.
2932
+ description: Total amount, in the user's default currency, of recurring activity that has occurred for the given date range
2850
2933
  type: number
2851
2934
  recurring_remaining:
2852
- description: Total amount, in the user's default currency, of expected recurring activity that has not yet occurred.
2935
+ description: Total amount, in the user's default currency, of expected recurring activity that has not yet occurred
2853
2936
  type: number
2854
2937
  uncategorized:
2855
- description: Total amount, in the user's default currency, of non recurring activity coming from un-categorized transactions.
2938
+ description: Total amount, in the user's default currency, of non recurring activity coming from un-categorized transactions
2856
2939
  type: number
2857
2940
  uncategorized_count:
2858
- description: Number of un-categorized transactions for the given date range.
2941
+ description: Number of un-categorized transactions for the given date range
2859
2942
  type: integer
2860
2943
  uncategorized_recurring:
2861
2944
  description: "Total amount, in the user's default currency, of recurring activity coming from un-categorized transactions."
@@ -3043,19 +3126,19 @@ components:
3043
3126
  This is only returned if the query parameter `include_occurrences` is set to `true`."
3044
3127
  properties:
3045
3128
  in_range:
3046
- description: true if this occurrence is within the given date range.
3129
+ description: true if this occurrence is within the given date range
3047
3130
  type: boolean
3048
3131
  start_date:
3049
- description: The start date of the budget period.
3132
+ description: The start date of the budget period
3050
3133
  type: string
3051
3134
  format: date
3052
3135
  end_date:
3053
- description: The end date of the budget period.
3136
+ description: The end date of the budget period
3054
3137
  type: string
3055
3138
  format: date
3056
3139
  other_activity:
3057
3140
  description: Total non recurring activity, in the user's default currency, for the category within the given date range.
3058
- The total activity for the category is the sum of this and the recurring_activity.
3141
+ The total activity for the category is the sum of this and the recurring_activity
3059
3142
  type: number
3060
3143
  recurring_activity:
3061
3144
  description: Total recurring activity, in the user's default currency, for the category within the given date range.
@@ -3066,11 +3149,11 @@ components:
3066
3149
  type: number
3067
3150
  nullable: true
3068
3151
  budgeted_amount:
3069
- description: Total budgeted amount in the budgeted currency for the category within the given date or null if the category is not budgeted.
3152
+ description: Total budgeted amount in the budgeted currency for the category within the given date or null if the category is not budgeted
3070
3153
  type: string
3071
3154
  nullable: true
3072
3155
  budgeted_currency:
3073
- description: Currency of the budgeted amount.
3156
+ description: Currency of the budgeted amount
3074
3157
  nullable: true
3075
3158
  allOf:
3076
3159
  - $ref: "#/components/schemas/currencyEnum"
@@ -3128,7 +3211,7 @@ components:
3128
3211
  description: "Amount of funds, in the user's default currency, currently available to rollover."
3129
3212
  type: number
3130
3213
  all_adjustments:
3131
- description: List of previous adjustments to the rollover pool.
3214
+ description: List of previous adjustments to the rollover pool
3132
3215
  type: array
3133
3216
  items:
3134
3217
  $ref: "#/components/schemas/summaryRolloverPoolAdjustmentObject"
@@ -3162,7 +3245,7 @@ components:
3162
3245
  errors:
3163
3246
  - errMsg: Too many requests, please try again later.
3164
3247
  serverError:
3165
- description: Internal Server Error. Contact support.
3248
+ description: Internal Server Error. Contact support
3166
3249
  content:
3167
3250
  application/json:
3168
3251
  schema:
@@ -3204,7 +3287,7 @@ paths:
3204
3287
  parameters: []
3205
3288
  responses:
3206
3289
  "200":
3207
- description: The User Object associated with the authorized token.
3290
+ description: The User Object associated with the authorized token
3208
3291
  content:
3209
3292
  application/json:
3210
3293
  schema:
@@ -3228,12 +3311,12 @@ paths:
3228
3311
  tags:
3229
3312
  - summary
3230
3313
  summary: Get summary
3231
- description: Returns a summary of the budget activity for the specified date range.
3314
+ description: Returns a summary of the budget activity for the specified date range
3232
3315
  operationId: getBudgetSummary
3233
3316
  parameters:
3234
3317
  - in: query
3235
3318
  name: start_date
3236
- description: Start of date range in ISO 8601 date format (YYYY-MM-DD).
3319
+ description: Start of date range in ISO 8601 date format (YYYY-MM-DD)
3237
3320
  required: true
3238
3321
  schema:
3239
3322
  type: string
@@ -3265,7 +3348,7 @@ paths:
3265
3348
  value: "2025-08-27"
3266
3349
  - in: query
3267
3350
  name: include_exclude_from_budgets
3268
- description: Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array.
3351
+ description: Enable to include categories that have the 'Exclude from Budgets' flag set in the returned `categories` array
3269
3352
  required: false
3270
3353
  schema:
3271
3354
  type: boolean
@@ -3300,7 +3383,7 @@ paths:
3300
3383
  default: false
3301
3384
  responses:
3302
3385
  "200":
3303
- description: Budget summary for the requested range.
3386
+ description: Budget summary for the requested range
3304
3387
  content:
3305
3388
  application/json:
3306
3389
  schema:
@@ -3721,7 +3804,7 @@ paths:
3721
3804
  tags:
3722
3805
  - categories
3723
3806
  summary: Get all categories
3724
- description: Retrieve a list of all categories associated with the user's account.
3807
+ description: Retrieve a list of all categories associated with the user's account
3725
3808
  operationId: getAllCategories
3726
3809
  parameters:
3727
3810
  - name: format
@@ -4071,7 +4154,7 @@ paths:
4071
4154
  tags:
4072
4155
  - categories
4073
4156
  summary: Get a single category
4074
- description: Retrieve details of a specific category or category group by its ID.
4157
+ description: Retrieve details of a specific category or category group by its ID
4075
4158
  operationId: getCategoryById
4076
4159
  parameters:
4077
4160
  - name: id
@@ -4093,7 +4176,7 @@ paths:
4093
4176
  value: 543210
4094
4177
  responses:
4095
4178
  "201":
4096
- description: Category Object with the requested category or category group.
4179
+ description: Category Object with the requested category or category group
4097
4180
  content:
4098
4181
  application/json:
4099
4182
  schema:
@@ -4459,32 +4542,36 @@ paths:
4459
4542
  manual_accounts:
4460
4543
  - id: 119807
4461
4544
  name: Individual Brokerage
4545
+ institution_name: Fidelity
4546
+ display_name: null
4462
4547
  type: investment
4463
4548
  subtype: brokerage
4464
- display_name: null
4465
4549
  balance: "41211.8000"
4466
- balance_as_of: "2025-06-25T17:00:04.000Z"
4467
- closed_on: null
4468
4550
  currency: usd
4469
4551
  to_base: 41211.8
4470
- institution_name: Fidelity
4552
+ balance_as_of: "2025-06-25T17:00:04.000Z"
4553
+ status: active
4554
+ closed_on: null
4471
4555
  external_id: null
4472
4556
  exclude_from_transactions: false
4557
+ created_by_name: User 1
4473
4558
  created_at: "2025-06-25T17:00:04.414Z"
4474
4559
  updated_at: "2025-06-26T19:03:38.312Z"
4475
4560
  - id: 119909
4476
4561
  name: Euro Travel Card
4562
+ institution_name: WeBank
4563
+ display_name: null
4477
4564
  type: credit
4478
4565
  subtype: credit card
4479
- display_name: null
4480
4566
  balance: "1004.8000"
4481
- balance_as_of: "2023-06-25T17:00:04.000Z"
4482
- closed_on: null
4483
4567
  currency: usd
4484
4568
  to_base: 1004.8
4485
- institution_name: WeBank
4569
+ balance_as_of: "2023-06-25T17:00:04.000Z"
4570
+ status: active
4571
+ closed_on: null
4486
4572
  external_id: null
4487
4573
  exclude_from_transactions: false
4574
+ created_by_name: User 1
4488
4575
  created_at: "2025-06-25T17:00:04.414Z"
4489
4576
  updated_at: "2025-06-26T19:03:38.312Z"
4490
4577
  "400":
@@ -4512,7 +4599,7 @@ paths:
4512
4599
  tags:
4513
4600
  - manual_accounts
4514
4601
  summary: Create a manual account
4515
- description: Create a new manually-managed account.<br><br>
4602
+ description: Creates a new manually-managed account
4516
4603
  operationId: createManualAccount
4517
4604
  requestBody:
4518
4605
  required: true
@@ -4566,34 +4653,38 @@ paths:
4566
4653
  value:
4567
4654
  id: 119999
4568
4655
  name: API created Account
4656
+ institution_name: null
4569
4657
  display_name: null
4570
4658
  type: cash
4571
4659
  subtype: null
4572
4660
  balance: "100"
4573
- balance_as_of: "2024-10-06T18:55:08.599Z"
4574
- closed_on: null
4575
4661
  currency: usd
4576
4662
  to_base: 100
4577
- institution_name: null
4663
+ balance_as_of: "2024-10-06T18:55:08.599Z"
4664
+ status: active
4665
+ closed_on: null
4578
4666
  external_id: null
4579
4667
  exclude_from_transactions: false
4668
+ created_by_name: User 1
4580
4669
  created_at: "2024-10-06T18:55:08.599Z"
4581
4670
  updated_at: "2024-10-06T18:55:08.599Z"
4582
4671
  complete request response:
4583
4672
  value:
4584
4673
  id: 119999
4585
4674
  name: API created loan
4675
+ institution_name: Bank of America
4586
4676
  display_name: Car loan
4587
4677
  type: vehicle
4588
4678
  subtype: loan
4589
4679
  balance: "9999.99"
4590
- balance_as_of: "2024-10-06T18:55:08.599Z"
4591
- closed_on: null
4592
4680
  currency: usd
4593
4681
  to_base: 9999.99
4594
- institution_name: Bank of America
4682
+ balance_as_of: "2024-10-06T18:55:08.599Z"
4683
+ status: active
4684
+ closed_on: null
4595
4685
  external_id: null
4596
4686
  exclude_from_transactions: false
4687
+ created_by_name: User 1
4597
4688
  created_at: "2024-10-06T18:57:12.029Z"
4598
4689
  updated_at: "2024-10-06T18:57:12.029Z"
4599
4690
  "400":
@@ -4641,7 +4732,7 @@ paths:
4641
4732
  tags:
4642
4733
  - manual_accounts
4643
4734
  summary: Get a single manual account
4644
- description: Retrieve the details of the manual account with the specified ID.
4735
+ description: Retrieve the details of the manual account with the specified ID
4645
4736
  operationId: getManualAccountById
4646
4737
  parameters:
4647
4738
  - name: id
@@ -4660,7 +4751,7 @@ paths:
4660
4751
  value: 9999999999999
4661
4752
  responses:
4662
4753
  "200":
4663
- description: Manual Account Object with the requested account.
4754
+ description: Manual Account Object with the requested account
4664
4755
  content:
4665
4756
  application/json:
4666
4757
  schema:
@@ -4668,17 +4759,19 @@ paths:
4668
4759
  example:
4669
4760
  id: 119807
4670
4761
  name: Individual Brokerage
4762
+ institution_name: Fidelity
4763
+ display_name: null
4671
4764
  type: investment
4672
4765
  subtype: brokerage
4673
- display_name: null
4674
4766
  balance: "41211.8000"
4675
- balance_as_of: "2025-06-25T17:00:04.000Z"
4676
- closed_on: null
4677
4767
  currency: usd
4678
4768
  to_base: 41211.8
4679
- institution_name: Fidelity
4769
+ balance_as_of: "2025-06-25T17:00:04.000Z"
4770
+ status: active
4771
+ closed_on: null
4680
4772
  external_id: null
4681
4773
  exclude_from_transactions: false
4774
+ created_by_name: User 1
4682
4775
  created_at: "2025-06-25T17:00:04.414Z"
4683
4776
  updated_at: "2025-06-26T19:03:38.312Z"
4684
4777
  "400":
@@ -4784,34 +4877,38 @@ paths:
4784
4877
  value:
4785
4878
  id: 119807
4786
4879
  name: Individual Brokerage
4880
+ institution_name: Fidelity
4881
+ display_name: null
4787
4882
  type: investment
4788
4883
  subtype: brokerage
4789
- display_name: null
4790
4884
  balance: "41211.8000"
4791
- balance_as_of: "2025-06-25T17:00:04.000Z"
4792
- closed_on: null
4793
4885
  currency: usd
4794
4886
  to_base: 41211.8
4887
+ balance_as_of: "2025-06-25T17:00:04.000Z"
4888
+ status: active
4889
+ closed_on: null
4795
4890
  external_id: null
4796
- institution_name: Fidelity
4797
4891
  exclude_from_transactions: false
4892
+ created_by_name: User 1
4798
4893
  created_at: "2025-06-25T17:00:04.414Z"
4799
4894
  updated_at: "2025-06-26T19:03:38.312Z"
4800
4895
  closed account:
4801
4896
  value:
4802
4897
  id: 119807
4803
4898
  name: Individual Brokerage
4899
+ institution_name: Fidelity
4900
+ display_name: null
4804
4901
  type: investment
4805
4902
  subtype: brokerage
4806
- display_name: null
4807
4903
  balance: "41211.8000"
4808
- balance_as_of: "2025-06-25T17:00:04.000Z"
4809
- closed_on: "2024-10-06"
4810
4904
  currency: usd
4811
4905
  to_base: 41211.8
4906
+ balance_as_of: "2025-06-25T17:00:04.000Z"
4907
+ status: closed
4908
+ closed_on: "2024-10-06"
4812
4909
  external_id: null
4813
- institution_name: Fidelity
4814
4910
  exclude_from_transactions: true
4911
+ created_by_name: User 1
4815
4912
  created_at: "2025-06-25T17:00:04.414Z"
4816
4913
  updated_at: "2024-10-06T19:03:09.506Z"
4817
4914
  "400":
@@ -4935,7 +5032,9 @@ paths:
4935
5032
  example:
4936
5033
  plaid_accounts:
4937
5034
  - id: 119804
5035
+ plaid_item_id: "aB2cD3eF4gH5iJ6kL7mN8oP9qR0sT1uV2wX3yZ4"
4938
5036
  date_linked: "2020-01-28"
5037
+ linked_by_name: User 1
4939
5038
  name: 401k
4940
5039
  display_name: ""
4941
5040
  type: brokerage
@@ -4948,13 +5047,15 @@ paths:
4948
5047
  balance: "12345.6700"
4949
5048
  currency: usd
4950
5049
  to_base: 12345.67
4951
- balance_last_update: "2020-01-27T01:38:11.862Z"
5050
+ balance_last_update: "2025-01-27T01:38:11.862Z"
4952
5051
  import_start_date: "2023-01-01"
4953
- last_import: "2019-09-04T12:57:09.190Z"
4954
- last_fetch: "2020-01-28T01:38:11.862Z"
4955
- plaid_last_successful_update: "2020-01-27T01:38:11.862Z"
5052
+ last_import: "2025-01-24T12:57:09.190Z"
5053
+ last_fetch: "2025-01-28T01:38:11.862Z"
5054
+ plaid_last_successful_update: "2025-01-27T01:38:11.862Z"
4956
5055
  - id: 119805
5056
+ plaid_item_id: "xY9zW8vU7tS6rQ5pO4nM3lK2jI1hG0fE9dC8bA7"
4957
5057
  date_linked: "2020-01-28"
5058
+ linked_by_name: User 1
4958
5059
  name: Freedom
4959
5060
  display_name: Penny's Visa
4960
5061
  type: credit
@@ -4967,13 +5068,15 @@ paths:
4967
5068
  balance: "0.0000"
4968
5069
  currency: usd
4969
5070
  to_base: 0
4970
- balance_last_update: "2023-01-27T01:38:07.460Z"
5071
+ balance_last_update: "2025-01-27T01:38:07.460Z"
4971
5072
  import_start_date: "2023-01-01"
4972
- last_import: "2023-01-24T12:57:03.250Z"
4973
- last_fetch: "2023-01-28T01:38:11.862Z"
4974
- plaid_last_successful_update: "2023-01-27T01:38:11.862Z"
4975
- - id: 119806
5073
+ last_import: "2025-01-24T12:57:03.250Z"
5074
+ last_fetch: "2025-01-28T01:38:11.862Z"
5075
+ plaid_last_successful_update: "2025-01-27T01:38:11.862Z"
5076
+ - id: 119807
5077
+ plaid_item_id: "mK8nL9oP0qR1sT2uV3wX4yZ5aB6cD7eF8gH9iJ0"
4976
5078
  date_linked: "2020-01-28"
5079
+ linked_by_name: User 1
4977
5080
  name: Checking
4978
5081
  display_name: Penny's Checking
4979
5082
  type: cash
@@ -4986,11 +5089,11 @@ paths:
4986
5089
  balance: "5498.2800"
4987
5090
  currency: usd
4988
5091
  to_base: 5498.28
4989
- balance_last_update: "2023-01-27T01:38:07.460Z"
5092
+ balance_last_update: "2025-01-27T01:38:07.460Z"
4990
5093
  import_start_date: "2023-01-01"
4991
- last_import: "2023-01-24T12:57:03.250Z"
4992
- last_fetch: "2023-01-28T01:38:11.862Z"
4993
- plaid_last_successful_update: "2023-01-27T01:38:11.862Z"
5094
+ last_import: "2025-01-24T12:57:03.250Z"
5095
+ last_fetch: "2025-01-28T01:38:11.862Z"
5096
+ plaid_last_successful_update: "2025-01-27T01:38:11.862Z"
4994
5097
  "400":
4995
5098
  description: Bad Request
4996
5099
  content:
@@ -5017,7 +5120,7 @@ paths:
5017
5120
  tags:
5018
5121
  - plaid_accounts
5019
5122
  summary: Get a single account that is synced via Plaid
5020
- description: Retrieve the details of the plaid account with the specified ID.
5123
+ description: Retrieve the details of the plaid account with the specified ID
5021
5124
  operationId: getPlaidAccountById
5022
5125
  parameters:
5023
5126
  - name: id
@@ -5036,14 +5139,16 @@ paths:
5036
5139
  value: 9999999999999
5037
5140
  responses:
5038
5141
  "200":
5039
- description: Plaid Account Object with the requested account.
5142
+ description: Plaid Account Object with the requested account
5040
5143
  content:
5041
5144
  application/json:
5042
5145
  schema:
5043
5146
  $ref: "#/components/schemas/plaidAccountObject"
5044
5147
  example:
5045
5148
  id: 119805
5149
+ plaid_item_id: "xY9zW8vU7tS6rQ5pO4nM3lK2jI1hG0fE9dC8bA7"
5046
5150
  date_linked: "2020-01-28"
5151
+ linked_by_name: User 1
5047
5152
  name: Freedom
5048
5153
  display_name: Penny's Visa
5049
5154
  type: credit
@@ -5056,11 +5161,11 @@ paths:
5056
5161
  balance: "0.0000"
5057
5162
  currency: usd
5058
5163
  to_base: 0
5059
- balance_last_update: "2023-01-27T01:38:07.460Z"
5164
+ balance_last_update: "2025-01-27T01:38:07.460Z"
5060
5165
  import_start_date: "2023-01-01"
5061
- last_import: "2023-01-24T12:57:03.250Z"
5062
- last_fetch: "2023-01-28T01:38:11.862Z"
5063
- plaid_last_successful_update: "2023-01-27T01:38:11.862Z"
5166
+ last_import: "2025-01-24T12:57:03.250Z"
5167
+ last_fetch: "2025-01-28T01:38:11.862Z"
5168
+ plaid_last_successful_update: "2025-01-27T01:38:11.862Z"
5064
5169
  "400":
5065
5170
  description: Bad Request
5066
5171
  content:
@@ -5120,7 +5225,7 @@ paths:
5120
5225
  schema:
5121
5226
  type: string
5122
5227
  format: date
5123
- description: Denotes the beginning of the time period to fetch transactions for.
5228
+ description: Denotes the beginning of the time period to fetch transactions for
5124
5229
  If omitted, the most recent transactions will be returned. <br>
5125
5230
  Required if end_date exists. <br>
5126
5231
  - name: end_date
@@ -5205,7 +5310,7 @@ paths:
5205
5310
  schema:
5206
5311
  type: string
5207
5312
  format: date
5208
- description: Denotes the beginning of the time period to fetch transactions for.
5313
+ description: Denotes the beginning of the time period to fetch transactions for
5209
5314
  If omitted, the most recent transactions will be returned. See
5210
5315
  `limit`. Required if end_date exists. <br>
5211
5316
  - name: end_date
@@ -5446,6 +5551,7 @@ paths:
5446
5551
  to_base: 1250.84
5447
5552
  recurring_id: 994069
5448
5553
  payee: Paycheck
5554
+ original_name: DIRECT DEPOSIT PAYROLL
5449
5555
  category_id: 88
5450
5556
  notes: null
5451
5557
  status: reviewed
@@ -5469,6 +5575,7 @@ paths:
5469
5575
  to_base: 21.98
5470
5576
  recurring_id: null
5471
5577
  payee: Noodle House
5578
+ original_name: NOODLE HOUSE RESTAURANT #5678
5472
5579
  category_id: null
5473
5580
  notes: null
5474
5581
  status: unreviewed
@@ -5492,6 +5599,7 @@ paths:
5492
5599
  to_base: -847.22
5493
5600
  recurring_id: null
5494
5601
  payee: Credit Card Payment
5602
+ original_name: CHASE CREDIT CARD PAYMENT
5495
5603
  category_id: 82
5496
5604
  is_pending: false
5497
5605
  status: reviewed
@@ -5514,6 +5622,7 @@ paths:
5514
5622
  to_base: 250
5515
5623
  recurring_id: null
5516
5624
  payee: Fidelity
5625
+ original_name: Fidelity
5517
5626
  category_id: 82
5518
5627
  notes: Transfer from Checking to Fidelity
5519
5628
  status: reviewed
@@ -5541,6 +5650,7 @@ paths:
5541
5650
  to_base: 1250.84
5542
5651
  recurring_id: 994069
5543
5652
  payee: Paycheck
5653
+ original_name: DIRECT DEPOSIT PAYROLL
5544
5654
  category_id: 88
5545
5655
  notes: null
5546
5656
  status: reviewed
@@ -5564,6 +5674,7 @@ paths:
5564
5674
  to_base: 1250.84
5565
5675
  recurring_id: 994069
5566
5676
  payee: Paycheck
5677
+ original_name: DIRECT DEPOSIT PAYROLL
5567
5678
  category_id: 88
5568
5679
  notes: null
5569
5680
  status: reviewed
@@ -5592,6 +5703,7 @@ paths:
5592
5703
  to_base: 1250.84
5593
5704
  recurring_id: 994069
5594
5705
  payee: Paycheck
5706
+ original_name: DIRECT DEPOSIT PAYROLL
5595
5707
  category_id: 88
5596
5708
  notes: null
5597
5709
  status: reviewed
@@ -5615,6 +5727,7 @@ paths:
5615
5727
  to_base: 21.98
5616
5728
  recurring_id: null
5617
5729
  payee: Noodle House
5730
+ original_name: NOODLE HOUSE RESTAURANT #5678
5618
5731
  category_id: null
5619
5732
  notes: null
5620
5733
  status: unreviewed
@@ -5658,13 +5771,11 @@ paths:
5658
5771
  - transactions (bulk)
5659
5772
  summary: Insert one or more transactions.
5660
5773
  description: >-
5661
- Use this endpoint to add transactions to a budget.
5662
-
5774
+ Use this endpoint to add transactions to a budget.<br><br>
5663
5775
 
5664
5776
  The request body for this endpoint must include a list of transactions
5665
5777
  with at least one transaction and not more than 500 transactions to
5666
- insert.
5667
-
5778
+ insert.<br><br>
5668
5779
 
5669
5780
  The successful request to this endpoint will return a response
5670
5781
  body which will include two arrays:
@@ -6636,6 +6747,7 @@ paths:
6636
6747
  to_base: 21.98
6637
6748
  recurring_id: null
6638
6749
  payee: Noodle House
6750
+ original_name: NOODLE HOUSE RESTAURANT #5678
6639
6751
  category_id: null
6640
6752
  notes: null
6641
6753
  status: unreviewed
@@ -6660,6 +6772,7 @@ paths:
6660
6772
  to_base: 1250.84
6661
6773
  recurring_id: 994069
6662
6774
  payee: Paycheck
6775
+ original_name: DIRECT DEPOSIT PAYROLL
6663
6776
  category_id: null
6664
6777
  notes: null
6665
6778
  status: pending
@@ -6697,6 +6810,7 @@ paths:
6697
6810
  to_base: 25.69
6698
6811
  recurring_id: null
6699
6812
  payee: Valero
6813
+ original_name: Valero
6700
6814
  category_id: 315174
6701
6815
  notes: Net Gas for roadtrip
6702
6816
  status: reviewed
@@ -6721,6 +6835,7 @@ paths:
6721
6835
  to_base: 25
6722
6836
  recurring_id: null
6723
6837
  payee: Me
6838
+ original_name: Me
6724
6839
  category_id: 315174
6725
6840
  notes: Gas repay from Tim for roadtrip
6726
6841
  status: reviewed