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