@lunch-money/developer-docs 2.11.1-preview.8 → 2.11.1-preview.9

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.
@@ -5099,9 +5099,58 @@ components:
5099
5099
  bearerSecurity:
5100
5100
  type: http
5101
5101
  description: >-
5102
- Required for the LIVE server. Optional for MOCK.
5102
+ A Lunch Money personal access token. Required for the LIVE server and
5103
+ optional for MOCK.
5103
5104
  scheme: bearer
5104
5105
  bearerFormat: JWT
5106
+ oauth2Security:
5107
+ type: oauth2
5108
+ description: >-
5109
+ An OAuth 2.0 access token issued to a registered Lunch Money app.
5110
+ Each operation lists the scope required to call it.
5111
+ flows:
5112
+ authorizationCode:
5113
+ authorizationUrl: https://api.lunchmoney.dev/oauth/authorize
5114
+ tokenUrl: https://api.lunchmoney.dev/oauth/token
5115
+ scopes:
5116
+ offline_access: "Allow this app to maintain access without asking you to sign in and authorize it again"
5117
+ me:read: "View your Lunch Money identity and account, user, and budget settings"
5118
+ me:update: "Update your Lunch Money account, user, and budget settings"
5119
+ summary:read: "View your budget summary"
5120
+ categories:read: "View categories and category groups"
5121
+ categories:create: "Create categories and category groups"
5122
+ categories:update: "Update categories and category groups"
5123
+ categories:delete: "Delete categories and category groups"
5124
+ crypto_manual:read: "View supported cryptocurrencies and manually managed cryptocurrency balances"
5125
+ crypto_manual:create: "Add supported cryptocurrencies and create manually managed cryptocurrency balances"
5126
+ crypto_manual:update: "Update manually managed cryptocurrency balances"
5127
+ crypto_manual:delete: "Delete manually managed cryptocurrency balances"
5128
+ crypto_synced:read: "View synced cryptocurrency accounts and balances"
5129
+ crypto_synced:update: "Refresh balances for synced cryptocurrency accounts"
5130
+ balance_history:read: "View balance history for accounts and synced cryptocurrency balances"
5131
+ balance_history:update: "Create or update balance history and details for deleted accounts"
5132
+ balance_history:delete: "Delete balance history for accounts and synced cryptocurrency balances"
5133
+ manual_accounts:read: "View manually managed accounts"
5134
+ manual_accounts:create: "Create manually managed accounts"
5135
+ manual_accounts:update: "Update manually managed accounts"
5136
+ manual_accounts:delete: "Delete manually managed accounts"
5137
+ plaid_accounts:read: "View accounts connected through Plaid"
5138
+ plaid_accounts:update: "Request a Plaid account refresh, which may import new transactions"
5139
+ transactions:read: "View transactions, including split and group information and attachment metadata"
5140
+ transactions:create: "Create transactions"
5141
+ transactions:update: "Update, split, unsplit, group, and ungroup transactions"
5142
+ transactions:delete: "Delete transactions"
5143
+ transaction_attachments:read: "Get download access to transaction attachments"
5144
+ transaction_attachments:create: "Attach files to transactions"
5145
+ transaction_attachments:delete: "Delete transaction attachments"
5146
+ tags:read: "View tags"
5147
+ tags:create: "Create tags"
5148
+ tags:update: "Update tags"
5149
+ tags:delete: "Delete tags"
5150
+ recurring_items:read: "View recurring items"
5151
+ budgets:read: "View budget period settings"
5152
+ budgets:update: "Create or update budget amounts"
5153
+ budgets:delete: "Delete budget amounts"
5105
5154
 
5106
5155
  paths:
5107
5156
  /me:
@@ -5120,6 +5169,10 @@ paths:
5120
5169
  Properties such as `primary_currency` and `budget_name` remain on this
5121
5170
  response for backwards compatibility.
5122
5171
  operationId: getMe
5172
+ security:
5173
+ - bearerSecurity: []
5174
+ - oauth2Security:
5175
+ - me:read
5123
5176
  parameters: []
5124
5177
  responses:
5125
5178
  "200":
@@ -5151,6 +5204,10 @@ paths:
5151
5204
  Returns settings for the current budgeting account. These settings apply
5152
5205
  regardless of which user is accessing the account.
5153
5206
  operationId: getAccountSettings
5207
+ security:
5208
+ - bearerSecurity: []
5209
+ - oauth2Security:
5210
+ - me:read
5154
5211
  responses:
5155
5212
  "200":
5156
5213
  description: Account settings for the current budgeting account
@@ -5186,6 +5243,10 @@ paths:
5186
5243
  provide only the properties to update. The request body must include at
5187
5244
  least one property.
5188
5245
  operationId: updateAccountSettings
5246
+ security:
5247
+ - bearerSecurity: []
5248
+ - oauth2Security:
5249
+ - me:update
5189
5250
  requestBody:
5190
5251
  required: true
5191
5252
  content:
@@ -5229,6 +5290,10 @@ paths:
5229
5290
  These settings apply across every budgeting account the user owns or
5230
5291
  collaborates on.
5231
5292
  operationId: getUserSettings
5293
+ security:
5294
+ - bearerSecurity: []
5295
+ - oauth2Security:
5296
+ - me:read
5232
5297
  responses:
5233
5298
  "200":
5234
5299
  description: User settings for the authorized user
@@ -5266,6 +5331,10 @@ paths:
5266
5331
  Amount fields in API responses always use positive values for debits and
5267
5332
  negative values for credits.
5268
5333
  operationId: updateUserSettings
5334
+ security:
5335
+ - bearerSecurity: []
5336
+ - oauth2Security:
5337
+ - me:update
5269
5338
  requestBody:
5270
5339
  required: true
5271
5340
  content:
@@ -5311,6 +5380,10 @@ paths:
5311
5380
  budgeting account. These settings do not affect other users or the
5312
5381
  authorized user's settings in other budgeting accounts.
5313
5382
  operationId: getUserAccountSettings
5383
+ security:
5384
+ - bearerSecurity: []
5385
+ - oauth2Security:
5386
+ - me:read
5314
5387
  responses:
5315
5388
  "200":
5316
5389
  description: Settings for the authorized user in the current budgeting
@@ -5340,6 +5413,10 @@ paths:
5340
5413
  provide only the properties to update. The request body must include at
5341
5414
  least one property.
5342
5415
  operationId: updateUserAccountSettings
5416
+ security:
5417
+ - bearerSecurity: []
5418
+ - oauth2Security:
5419
+ - me:update
5343
5420
  requestBody:
5344
5421
  required: true
5345
5422
  content:
@@ -5394,6 +5471,10 @@ paths:
5394
5471
  budget objects.
5395
5472
 
5396
5473
  operationId: getBudgetSummary
5474
+ security:
5475
+ - bearerSecurity: []
5476
+ - oauth2Security:
5477
+ - summary:read
5397
5478
  parameters:
5398
5479
  - in: query
5399
5480
  name: start_date
@@ -5909,6 +5990,10 @@ paths:
5909
5990
  description: Retrieve a list of all categories associated with the user's
5910
5991
  account.
5911
5992
  operationId: getAllCategories
5993
+ security:
5994
+ - bearerSecurity: []
5995
+ - oauth2Security:
5996
+ - categories:read
5912
5997
  parameters:
5913
5998
  - name: format
5914
5999
  in: query
@@ -6156,6 +6241,10 @@ paths:
6156
6241
  this case, the `children` attribute may be set to an array of category
6157
6242
  IDs to add to the newly created category group.
6158
6243
  operationId: createCategory
6244
+ security:
6245
+ - bearerSecurity: []
6246
+ - oauth2Security:
6247
+ - categories:create
6159
6248
  requestBody:
6160
6249
  required: true
6161
6250
  content:
@@ -6261,6 +6350,10 @@ paths:
6261
6350
  description: Retrieve details of a specific category or category group by
6262
6351
  its ID.
6263
6352
  operationId: getCategoryById
6353
+ security:
6354
+ - bearerSecurity: []
6355
+ - oauth2Security:
6356
+ - categories:read
6264
6357
  parameters:
6265
6358
  - name: id
6266
6359
  in: path
@@ -6399,6 +6492,10 @@ paths:
6399
6492
 
6400
6493
  It is possible to modify the children of an existing category group with this API by setting the `children` attribute. If this is set, it will replace the existing children with the newly specified children. If the intention is to add or remove a single category, it is more straightforward to update the child category by specifying the new `group_id` attribute. If the goal is to add multiple new children or remove multiple existing children, it is recommended to first call the `GET /categories/{id}` endpoint to get the existing children and then modify the list as desired.<br><br>
6401
6494
  operationId: updateCategory
6495
+ security:
6496
+ - bearerSecurity: []
6497
+ - oauth2Security:
6498
+ - categories:update
6402
6499
  parameters:
6403
6500
  - name: id
6404
6501
  in: path
@@ -6551,6 +6648,10 @@ paths:
6551
6648
  recurring items, etc. If there are dependents, this endpoint will return
6552
6649
  an object that describes the number and type of existing dependencies.
6553
6650
  operationId: deleteCategory
6651
+ security:
6652
+ - bearerSecurity: []
6653
+ - oauth2Security:
6654
+ - categories:delete
6554
6655
  parameters:
6555
6656
  - in: path
6556
6657
  name: id
@@ -6634,6 +6735,10 @@ paths:
6634
6735
  Retrieve the list of cryptocurrencies currently supported for manual tracking.<p>
6635
6736
  When creating a new manual crypto balance via `POST /crypto/manual`, the `symbol` you specify must match the `symbol` of one of the entries returned by this endpoint.
6636
6737
  operationId: getAllCryptocurrencies
6738
+ security:
6739
+ - bearerSecurity: []
6740
+ - oauth2Security:
6741
+ - crypto_manual:read
6637
6742
  responses:
6638
6743
  "200":
6639
6744
  description: A list of supported cryptocurrencies
@@ -6670,6 +6775,10 @@ paths:
6670
6775
  - crypto-manual
6671
6776
  summary: Add a new supported cryptocurrency
6672
6777
  operationId: createCryptocurrency
6778
+ security:
6779
+ - bearerSecurity: []
6780
+ - oauth2Security:
6781
+ - crypto_manual:create
6673
6782
  description: |-
6674
6783
  Adds a new cryptocurrency to the supported manual-crypto list.<br><br>
6675
6784
  Lunch Money uses [CoinGecko](https://www.coingecko.com/us/coins/ethereum) to convert crypto balances to the user's primary currency. Users add a new supported cryptocurrency by submitting a CoinGecko coin-page URL. The server validates the URL, extracts the id from `/coins/{id}`, checks for an existing supported `coingecko_id`, validates the id against CoinGecko, then confirms the resolved symbol is not already supported before creating the new entry.
@@ -6754,6 +6863,10 @@ paths:
6754
6863
  description: |-
6755
6864
  Retrieve all manually managed crypto balances associated with the user's account.
6756
6865
  operationId: getAllCryptoManual
6866
+ security:
6867
+ - bearerSecurity: []
6868
+ - oauth2Security:
6869
+ - crypto_manual:read
6757
6870
  responses:
6758
6871
  "200":
6759
6872
  description: A list of manual crypto balances
@@ -6790,6 +6903,10 @@ paths:
6790
6903
  Create a manually managed crypto asset.<br><br>
6791
6904
  If `display_name` is `null`, clients may derive one from `institution_name` + `name`.
6792
6905
  operationId: createCryptoManual
6906
+ security:
6907
+ - bearerSecurity: []
6908
+ - oauth2Security:
6909
+ - crypto_manual:create
6793
6910
  requestBody:
6794
6911
  required: true
6795
6912
  content:
@@ -6876,6 +6993,10 @@ paths:
6876
6993
  description: |-
6877
6994
  Retrieve a single manually managed crypto balance by ID.
6878
6995
  operationId: getCryptoManualById
6996
+ security:
6997
+ - bearerSecurity: []
6998
+ - oauth2Security:
6999
+ - crypto_manual:read
6879
7000
  parameters:
6880
7001
  - name: id
6881
7002
  in: path
@@ -6946,6 +7067,10 @@ paths:
6946
7067
  Modify a manually managed crypto balance.<br><br>
6947
7068
  You may submit the response from `GET /crypto/manual/{id}` as the request body. System-defined properties are accepted according to the `x-updatable` metadata in the update schema.
6948
7069
  operationId: updateCryptoManual
7070
+ security:
7071
+ - bearerSecurity: []
7072
+ - oauth2Security:
7073
+ - crypto_manual:update
6949
7074
  parameters:
6950
7075
  - name: id
6951
7076
  in: path
@@ -7044,6 +7169,10 @@ paths:
7044
7169
  description: |-
7045
7170
  Delete a single manually managed crypto asset by ID.<p> If this crypto asset has a balance history, and you do not explicitly set the query parameter`keep_history`, a 422 response will be returned requesting you to explicitly set `keep_history` to `true` or `false`.
7046
7171
  operationId: deleteCryptoManual
7172
+ security:
7173
+ - bearerSecurity: []
7174
+ - oauth2Security:
7175
+ - crypto_manual:delete
7047
7176
  parameters:
7048
7177
  - name: id
7049
7178
  in: path
@@ -7110,6 +7239,10 @@ paths:
7110
7239
  description: |-
7111
7240
  Retrieves all synced crypto accounts associated with the user's account.
7112
7241
  operationId: getAllCryptoSynced
7242
+ security:
7243
+ - bearerSecurity: []
7244
+ - oauth2Security:
7245
+ - crypto_synced:read
7113
7246
  responses:
7114
7247
  "200":
7115
7248
  description: A list of synced crypto accounts
@@ -7173,6 +7306,10 @@ paths:
7173
7306
  description: |-
7174
7307
  Retrieves the synced crypto account and all nested balances for the specified synced crypto account ID.
7175
7308
  operationId: getCryptoSyncedById
7309
+ security:
7310
+ - bearerSecurity: []
7311
+ - oauth2Security:
7312
+ - crypto_synced:read
7176
7313
  parameters:
7177
7314
  - name: id
7178
7315
  in: path
@@ -7254,6 +7391,10 @@ paths:
7254
7391
  description: |-
7255
7392
  Retrieves a single balance from the specified synced crypto account using the crypto symbol.
7256
7393
  operationId: getCryptoSyncedBalanceBySymbol
7394
+ security:
7395
+ - bearerSecurity: []
7396
+ - oauth2Security:
7397
+ - crypto_synced:read
7257
7398
  parameters:
7258
7399
  - name: id
7259
7400
  in: path
@@ -7334,6 +7475,10 @@ paths:
7334
7475
  description: |-
7335
7476
  Trigger a balance refresh for the specified synced crypto account. Returns the refreshed synced crypto account.
7336
7477
  operationId: refreshCryptoSynced
7478
+ security:
7479
+ - bearerSecurity: []
7480
+ - oauth2Security:
7481
+ - crypto_synced:update
7337
7482
  parameters:
7338
7483
  - name: id
7339
7484
  in: path
@@ -7414,6 +7559,10 @@ paths:
7414
7559
  &nbsp;&nbsp;&nbsp;&nbsp;- `crypto_manual`: `source.crypto_manual_id` with [GET /crypto/manual/{id}](#tag/crypto-manual/GET/crypto/manual/{id})<br>
7415
7560
  &nbsp;&nbsp;&nbsp;&nbsp;- `crypto_synced`: `source.crypto_synced_id` and `source.symbol` with [GET /crypto/synced/{id}/{symbol}](#tag/crypto-synced/GET/crypto/synced/{id}/{symbol})
7416
7561
  operationId: getBalanceHistory
7562
+ security:
7563
+ - bearerSecurity: []
7564
+ - oauth2Security:
7565
+ - balance_history:read
7417
7566
  parameters:
7418
7567
  - name: start_month
7419
7568
  in: query
@@ -7669,6 +7818,10 @@ paths:
7669
7818
  The `account_type` path parameter identifies the account family (`manual`, `plaid`, `crypto_manual`, or `deleted`) and `account_id` identifies the account within that family.<br><br>
7670
7819
  `start_month`, `end_month`, and current-month entries behave as described in [GET /balance_history](#tag/balance-history/GET/balance_history).
7671
7820
  operationId: getBalanceHistoryForAccount
7821
+ security:
7822
+ - bearerSecurity: []
7823
+ - oauth2Security:
7824
+ - balance_history:read
7672
7825
  parameters:
7673
7826
  - name: account_type
7674
7827
  in: path
@@ -7805,6 +7958,10 @@ paths:
7805
7958
  `crypto_balance` may be provided for `crypto_manual` and `deleted` accounts. It is invalid for `manual` or `plaid` accounts.<br><br>
7806
7959
  The response contains only the `type: historical` balance entries that were submitted in this request.
7807
7960
  operationId: upsertBalanceHistoryForAccount
7961
+ security:
7962
+ - bearerSecurity: []
7963
+ - oauth2Security:
7964
+ - balance_history:update
7808
7965
  parameters:
7809
7966
  - name: account_type
7810
7967
  in: path
@@ -8001,6 +8158,10 @@ paths:
8001
8158
  description: |-
8002
8159
  Delete all historical balance entries for a single manual, Plaid, manual crypto, or deleted account. For synced crypto symbol streams, use [DELETE /balance_history/crypto_synced/{account_id}/{symbol}](#tag/balance-history/DELETE/balance_history/crypto_synced/{account_id}/{symbol}).
8003
8160
  operationId: deleteBalanceHistoryForAccount
8161
+ security:
8162
+ - bearerSecurity: []
8163
+ - oauth2Security:
8164
+ - balance_history:delete
8004
8165
  parameters:
8005
8166
  - name: account_type
8006
8167
  in: path
@@ -8047,6 +8208,10 @@ paths:
8047
8208
  The path selects one balance stream with a synced crypto account id and `symbol`.<br><br>
8048
8209
  `start_month`, `end_month`, and current-month entries behave as described in [GET /balance_history](#tag/balance-history/GET/balance_history).
8049
8210
  operationId: getBalanceHistoryForCryptoSynced
8211
+ security:
8212
+ - bearerSecurity: []
8213
+ - oauth2Security:
8214
+ - balance_history:read
8050
8215
  parameters:
8051
8216
  - name: account_id
8052
8217
  in: path
@@ -8155,6 +8320,10 @@ paths:
8155
8320
  `crypto_balance` may be provided for synced crypto balances.<br><br>
8156
8321
  The response contains only the `type: historical` balance entries that were submitted in this request.
8157
8322
  operationId: upsertBalanceHistoryForCryptoSynced
8323
+ security:
8324
+ - bearerSecurity: []
8325
+ - oauth2Security:
8326
+ - balance_history:update
8158
8327
  parameters:
8159
8328
  - name: account_id
8160
8329
  in: path
@@ -8299,6 +8468,10 @@ paths:
8299
8468
  Delete all historical balance entries for a single synced crypto symbol stream.<br><br>
8300
8469
  The path identifies both the synced crypto account and the symbol whose history should be deleted.
8301
8470
  operationId: deleteBalanceHistoryForCryptoSynced
8471
+ security:
8472
+ - bearerSecurity: []
8473
+ - oauth2Security:
8474
+ - balance_history:delete
8302
8475
  parameters:
8303
8476
  - name: account_id
8304
8477
  in: path
@@ -8342,6 +8515,10 @@ paths:
8342
8515
  description: |-
8343
8516
  Delete a single stored (`type: historical`) monthly balance history entry by its id. Ephemeral `current` entries cannot be deleted this way.
8344
8517
  operationId: deleteBalanceHistoryEntry
8518
+ security:
8519
+ - bearerSecurity: []
8520
+ - oauth2Security:
8521
+ - balance_history:delete
8345
8522
  parameters:
8346
8523
  - name: id
8347
8524
  in: path
@@ -8388,6 +8565,10 @@ paths:
8388
8565
  Update archived metadata for a deleted balance history source.<br><br>
8389
8566
  Pass the `deleted_account_id` from a `source.type: deleted` entry. The update applies to all historical entries associated with that deleted source.
8390
8567
  operationId: updateBalanceHistoryDetails
8568
+ security:
8569
+ - bearerSecurity: []
8570
+ - oauth2Security:
8571
+ - balance_history:update
8391
8572
  parameters:
8392
8573
  - name: account_id
8393
8574
  in: path
@@ -8459,6 +8640,10 @@ paths:
8459
8640
  description: Retrieve a list of all manually-managed accounts associated
8460
8641
  with the user's account.
8461
8642
  operationId: getAllManualAccounts
8643
+ security:
8644
+ - bearerSecurity: []
8645
+ - oauth2Security:
8646
+ - manual_accounts:read
8462
8647
  responses:
8463
8648
  "200":
8464
8649
  description: A list of manual accounts
@@ -8534,6 +8719,10 @@ paths:
8534
8719
  summary: Create a manual account
8535
8720
  description: Create a new manually-managed account.
8536
8721
  operationId: createManualAccount
8722
+ security:
8723
+ - bearerSecurity: []
8724
+ - oauth2Security:
8725
+ - manual_accounts:create
8537
8726
  requestBody:
8538
8727
  required: true
8539
8728
  content:
@@ -8668,6 +8857,10 @@ paths:
8668
8857
  description: Retrieve the details of the manual account with the specified
8669
8858
  ID.
8670
8859
  operationId: getManualAccountById
8860
+ security:
8861
+ - bearerSecurity: []
8862
+ - oauth2Security:
8863
+ - manual_accounts:read
8671
8864
  parameters:
8672
8865
  - name: id
8673
8866
  in: path
@@ -8752,6 +8945,10 @@ paths:
8752
8945
  properties that is not listed above. For example a request body that contains only a `name` property is valid.<br><br>
8753
8946
 
8754
8947
  operationId: updateManualAccount
8948
+ security:
8949
+ - bearerSecurity: []
8950
+ - oauth2Security:
8951
+ - manual_accounts:update
8755
8952
  parameters:
8756
8953
  - name: id
8757
8954
  in: path
@@ -8895,6 +9092,10 @@ paths:
8895
9092
  property set to this account's ID they will appear with a warning when
8896
9093
  displayed in the web view.
8897
9094
  operationId: deleteManualAccount
9095
+ security:
9096
+ - bearerSecurity: []
9097
+ - oauth2Security:
9098
+ - manual_accounts:delete
8898
9099
  parameters:
8899
9100
  - in: path
8900
9101
  name: id
@@ -8954,6 +9155,10 @@ paths:
8954
9155
  description: Retrieve a list of all synced accounts associated with the
8955
9156
  user's account.
8956
9157
  operationId: getAllPlaidAccounts
9158
+ security:
9159
+ - bearerSecurity: []
9160
+ - oauth2Security:
9161
+ - plaid_accounts:read
8957
9162
  responses:
8958
9163
  "200":
8959
9164
  description: A list of accounts synced via Plaid
@@ -9060,6 +9265,10 @@ paths:
9060
9265
  description: Retrieve the details of the plaid account with the specified
9061
9266
  ID.
9062
9267
  operationId: getPlaidAccountById
9268
+ security:
9269
+ - bearerSecurity: []
9270
+ - oauth2Security:
9271
+ - plaid_accounts:read
9063
9272
  parameters:
9064
9273
  - name: id
9065
9274
  in: path
@@ -9157,6 +9366,10 @@ paths:
9157
9366
  contacts the associated financial institution. The `last_import` field
9158
9367
  is updated only when new transactions have been imported.
9159
9368
  operationId: triggerPlaidAccountFetch
9369
+ security:
9370
+ - bearerSecurity: []
9371
+ - oauth2Security:
9372
+ - plaid_accounts:update
9160
9373
  parameters:
9161
9374
  - name: start_date
9162
9375
  in: query
@@ -9242,6 +9455,10 @@ paths:
9242
9455
  account. <br>If called with no parameters, this endpoint will return the
9243
9456
  most recent transactions, up to the specified `limit`.
9244
9457
  operationId: getAllTransactions
9458
+ security:
9459
+ - bearerSecurity: []
9460
+ - oauth2Security:
9461
+ - transactions:read
9245
9462
  parameters:
9246
9463
  - name: start_date
9247
9464
  in: query
@@ -9735,6 +9952,10 @@ paths:
9735
9952
  transactions that were duplicates of existing transactions and were not
9736
9953
  inserted.
9737
9954
  operationId: createNewTransactions
9955
+ security:
9956
+ - bearerSecurity: []
9957
+ - oauth2Security:
9958
+ - transactions:create
9738
9959
  requestBody:
9739
9960
  required: true
9740
9961
  content:
@@ -10175,6 +10396,10 @@ paths:
10175
10396
 
10176
10397
  The request can include between 1 and 500 transactions to update in a single call.
10177
10398
  operationId: updateTransactions
10399
+ security:
10400
+ - bearerSecurity: []
10401
+ - oauth2Security:
10402
+ - transactions:update
10178
10403
  requestBody:
10179
10404
  required: true
10180
10405
  content:
@@ -10543,6 +10768,10 @@ paths:
10543
10768
 
10544
10769
  <span class="red-text"><strong>Use with caution. This action is not reversible!</strong></span>
10545
10770
  operationId: deleteTransactions
10771
+ security:
10772
+ - bearerSecurity: []
10773
+ - oauth2Security:
10774
+ - transactions:delete
10546
10775
  requestBody:
10547
10776
  required: true
10548
10777
  content:
@@ -10659,6 +10888,10 @@ paths:
10659
10888
  include the `children` property which will contain a list
10660
10889
  of the split transactions.
10661
10890
  operationId: getTransactionById
10891
+ security:
10892
+ - bearerSecurity: []
10893
+ - oauth2Security:
10894
+ - transactions:read
10662
10895
  parameters:
10663
10896
  - name: id
10664
10897
  in: path
@@ -10902,6 +11135,10 @@ paths:
10902
11135
  an `category_id` attribute is valid.
10903
11136
 
10904
11137
  operationId: updateTransaction
11138
+ security:
11139
+ - bearerSecurity: []
11140
+ - oauth2Security:
11141
+ - transactions:update
10905
11142
  parameters:
10906
11143
  - name: id
10907
11144
  in: path
@@ -11036,6 +11273,10 @@ paths:
11036
11273
 
11037
11274
  <span class="red-text"><strong>Use with caution. This action is not reversible!</strong></span>
11038
11275
  operationId: deleteTransactionById
11276
+ security:
11277
+ - bearerSecurity: []
11278
+ - oauth2Security:
11279
+ - transactions:delete
11039
11280
  parameters:
11040
11281
  - in: path
11041
11282
  name: id
@@ -11109,6 +11350,10 @@ paths:
11109
11350
  be included in the `children` property of the transaction returned in
11110
11351
  the response
11111
11352
  operationId: groupTransactions
11353
+ security:
11354
+ - bearerSecurity: []
11355
+ - oauth2Security:
11356
+ - transactions:update
11112
11357
  requestBody:
11113
11358
  required: true
11114
11359
  content:
@@ -11401,6 +11646,10 @@ paths:
11401
11646
  The transactions within the group are not removed and will subsequently
11402
11647
  be treated as "normal" ungrouped transactions.
11403
11648
  operationId: ungroupTransactions
11649
+ security:
11650
+ - bearerSecurity: []
11651
+ - oauth2Security:
11652
+ - transactions:update
11404
11653
  parameters:
11405
11654
  - in: path
11406
11655
  name: id
@@ -11454,6 +11703,10 @@ paths:
11454
11703
  split, use the `GET /transactions/{id}` endpoint and pass the value of
11455
11704
  the `split_parent_id` of one of the children.
11456
11705
  operationId: splitTransaction
11706
+ security:
11707
+ - bearerSecurity: []
11708
+ - oauth2Security:
11709
+ - transactions:update
11457
11710
  parameters:
11458
11711
  - name: id
11459
11712
  in: path
@@ -11655,6 +11908,10 @@ paths:
11655
11908
  Use the value of the `split_parent_id`property of a split transaction to
11656
11909
  specify the parent ID.
11657
11910
  operationId: unsplitTransaction
11911
+ security:
11912
+ - bearerSecurity: []
11913
+ - oauth2Security:
11914
+ - transactions:update
11658
11915
  parameters:
11659
11916
  - in: path
11660
11917
  name: id
@@ -11696,6 +11953,10 @@ paths:
11696
11953
  - transactions (files)
11697
11954
  summary: Attach a file to a transaction
11698
11955
  operationId: attachFileToTransaction
11956
+ security:
11957
+ - bearerSecurity: []
11958
+ - oauth2Security:
11959
+ - transaction_attachments:create
11699
11960
  description: |-
11700
11961
  Attaches a file to a transaction. The file must be less than 10MB in size.<br><br> The file will be attached to the transaction and can be downloaded from the link returned by a `GET /transactions/attachments/{file_id}` request.
11701
11962
  parameters:
@@ -11783,6 +12044,10 @@ paths:
11783
12044
  description: |-
11784
12045
  Returns a signed url that can be used to download the file attachment.
11785
12046
  operationId: getTransactionAttachmentUrl
12047
+ security:
12048
+ - bearerSecurity: []
12049
+ - oauth2Security:
12050
+ - transaction_attachments:read
11786
12051
  tags:
11787
12052
  - transactions (files)
11788
12053
  parameters:
@@ -11836,6 +12101,10 @@ paths:
11836
12101
  delete:
11837
12102
  summary: Delete a file attachment
11838
12103
  operationId: deleteTransactionAttachment
12104
+ security:
12105
+ - bearerSecurity: []
12106
+ - oauth2Security:
12107
+ - transaction_attachments:delete
11839
12108
  description: >-
11840
12109
  Deletes a file attachment from a transaction.
11841
12110
  tags:
@@ -11881,6 +12150,10 @@ paths:
11881
12150
  description: Retrieve a list of all tags associated with the user's
11882
12151
  account.
11883
12152
  operationId: getAllTags
12153
+ security:
12154
+ - bearerSecurity: []
12155
+ - oauth2Security:
12156
+ - tags:read
11884
12157
  responses:
11885
12158
  "200":
11886
12159
  description: A list of tags
@@ -11951,6 +12224,10 @@ paths:
11951
12224
  summary: Create a new tag
11952
12225
  description: Creates a new tag with the given name
11953
12226
  operationId: createTag
12227
+ security:
12228
+ - bearerSecurity: []
12229
+ - oauth2Security:
12230
+ - tags:create
11954
12231
  requestBody:
11955
12232
  required: true
11956
12233
  content:
@@ -12018,6 +12295,10 @@ paths:
12018
12295
  summary: Get a single tag
12019
12296
  description: Retrieve the details of a specific tag with the specified ID.
12020
12297
  operationId: getTagById
12298
+ security:
12299
+ - bearerSecurity: []
12300
+ - oauth2Security:
12301
+ - tags:read
12021
12302
  parameters:
12022
12303
  - name: id
12023
12304
  in: path
@@ -12097,6 +12378,10 @@ paths:
12097
12378
  properties that is not listed above. For example, a request body that contains only a
12098
12379
  `name` attribute is valid.
12099
12380
  operationId: updateTag
12381
+ security:
12382
+ - bearerSecurity: []
12383
+ - oauth2Security:
12384
+ - tags:update
12100
12385
  parameters:
12101
12386
  - name: id
12102
12387
  in: path
@@ -12200,6 +12485,10 @@ paths:
12200
12485
  returned and the tag is not deleted. This behavior can be overridden by
12201
12486
  setting the `force` parameter to `true`.
12202
12487
  operationId: deleteTag
12488
+ security:
12489
+ - bearerSecurity: []
12490
+ - oauth2Security:
12491
+ - tags:delete
12203
12492
  parameters:
12204
12493
  - in: path
12205
12494
  name: id
@@ -12263,6 +12552,10 @@ paths:
12263
12552
  summary: Get all recurring items
12264
12553
  description: Retrieve recurring items for a specified time frame.
12265
12554
  operationId: getAllRecurring
12555
+ security:
12556
+ - bearerSecurity: []
12557
+ - oauth2Security:
12558
+ - recurring_items:read
12266
12559
  parameters:
12267
12560
  - name: start_date
12268
12561
  in: query
@@ -12406,6 +12699,10 @@ paths:
12406
12699
  description: Retrieve the details of a specific recurring item with the
12407
12700
  specified ID.
12408
12701
  operationId: getRecurringById
12702
+ security:
12703
+ - bearerSecurity: []
12704
+ - oauth2Security:
12705
+ - recurring_items:read
12409
12706
  parameters:
12410
12707
  - name: id
12411
12708
  in: path
@@ -12522,6 +12819,10 @@ paths:
12522
12819
  budget preferences such as currency and locale, see
12523
12820
  [/me/account/settings](#tag/me/GET/me/account/settings).
12524
12821
  operationId: getBudgetSettings
12822
+ security:
12823
+ - bearerSecurity: []
12824
+ - oauth2Security:
12825
+ - budgets:read
12525
12826
  responses:
12526
12827
  "200":
12527
12828
  description: Budget period settings for the current budget
@@ -12550,6 +12851,10 @@ paths:
12550
12851
  Use the [/budgets/settings](#tag/budgets/GET/budgets/settings) endpoint to view the budget period settings for the account.<br>
12551
12852
  To view details for existing budgets, use the [summary](#tag/summary) endpoint.
12552
12853
  operationId: upsertBudget
12854
+ security:
12855
+ - bearerSecurity: []
12856
+ - oauth2Security:
12857
+ - budgets:update
12553
12858
  requestBody:
12554
12859
  required: true
12555
12860
  content:
@@ -12622,6 +12927,10 @@ paths:
12622
12927
  the account's budget settings.<br> To view details for existing budgets,
12623
12928
  use the [summary](#tag/summary) endpoint.
12624
12929
  operationId: deleteBudget
12930
+ security:
12931
+ - bearerSecurity: []
12932
+ - oauth2Security:
12933
+ - budgets:delete
12625
12934
  parameters:
12626
12935
  - in: query
12627
12936
  name: category_id