Returns budgets list with summary information
643 matches
26 actions
YNAB API Endpoints
26 actions
- Account listGETv1.0.0
- Budget SettingsGETv1.0.0
- Create a new accountPOSTv1.0.0
- Create a single transaction or multiple transactionsPOSTv1.0.0
- Deletes an existing transactionDELETEv1.0.0
- List account transactionsGETv1.0.0
- List budget monthsGETv1.0.0
- List budgetsGETv1.0.0
- List categoriesGETv1.0.0
- List category transactionsGETv1.0.0
- List locations for a payeeGETv1.0.0
- List payee locationsGETv1.0.0
- List payee transactionsGETv1.0.0
- List payeesGETv1.0.0
- List scheduled transactionsGETv1.0.0
- List transactionsGETv1.0.0
- Single accountGETv1.0.0
- Single budgetGETv1.0.0
- Single budget monthGETv1.0.0
- Single payeeGETv1.0.0
- Single payee locationGETv1.0.0
- Single scheduled transactionGETv1.0.0
- Single transactionGETv1.0.0
- Update multiple transactionsPATCHv1.0.0
- Updates an existing transactionPUTv1.0.0
- User infoGETv1.0.0
Finance/YNAB API Endpoints
List budgets
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
{
"type": "object",
"properties": {
"include_accounts": {
"type": "boolean"
}
},
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"budgets"
],
"properties": {
"budgets": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"accounts": {
"type": "array",
"description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)",
"items": {
"type": "object",
"required": [
"id",
"name",
"type",
"on_budget",
"closed",
"balance",
"cleared_balance",
"uncleared_balance",
"transfer_payee_id",
"deleted"
],
"properties": {
"balance": {
"type": "integer",
"format": "int64",
"description": "The current balance of the account in milliunits format"
},
"cleared_balance": {
"type": "integer",
"format": "int64",
"description": "The current cleared balance of the account in milliunits format"
},
"closed": {
"type": "boolean",
"description": "Whether this account is closed or not"
},
"debt_escrow_amounts": {
"type": "object"
},
"debt_interest_rates": {
"type": "object"
},
"debt_minimum_payments": {
"type": "object"
},
"debt_original_balance": {
"type": "integer",
"format": "int64",
"description": "The original debt/loan account balance, specified in milliunits format."
},
"deleted": {
"type": "boolean",
"description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."
},
"direct_import_in_error": {
"type": "boolean",
"description": "If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true."
},
"direct_import_linked": {
"type": "boolean",
"description": "Whether or not the account is linked to a financial institution for automatic transaction import."
},
"id": {
"type": "string",
"format": "uuid"
},
"last_reconciled_at": {
"type": "string",
"format": "date-time",
"description": "A date/time specifying when the account was last reconciled."
},
"name": {
"type": "string"
},
"note": {
"type": "string"
},
"on_budget": {
"type": "boolean",
"description": "Whether this account is on budget or not"
},
"transfer_payee_id": {
"type": "string",
"format": "uuid",
"description": "The payee id which should be used when transferring to this account"
},
"type": {
"type": "string",
"description": "The type of account",
"enum": [
"checking",
"savings",
"cash",
"creditCard",
"lineOfCredit",
"otherAsset",
"otherLiability",
"mortgage",
"autoLoan",
"studentLoan",
"personalLoan",
"medicalDebt",
"otherDebt"
]
},
"uncleared_balance": {
"type": "integer",
"format": "int64",
"description": "The current uncleared balance of the account in milliunits format"
}
}
}
},
"currency_format": {
"type": "object",
"description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null.",
"required": [
"iso_code",
"example_format",
"decimal_digits",
"decimal_separator",
"symbol_first",
"group_separator",
"currency_symbol",
"display_symbol"
],
"properties": {
"currency_symbol": {
"type": "string"
},
"decimal_digits": {
"type": "integer",
"format": "int32"
},
"decimal_separator": {
"type": "string"
},
"display_symbol": {
"type": "boolean"
},
"example_format": {
"type": "string"
},
"group_separator": {
"type": "string"
},
"iso_code": {
"type": "string"
},
"symbol_first": {
"type": "boolean"
}
}
},
"date_format": {
"type": "object",
"description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null.",
"required": [
"format"
],
"properties": {
"format": {
"type": "string"
}
}
},
"first_month": {
"type": "string",
"format": "date",
"description": "The earliest budget month"
},
"id": {
"type": "string",
"format": "uuid"
},
"last_modified_on": {
"type": "string",
"format": "date-time",
"description": "The last time any changes were made to the budget from either a web or mobile client"
},
"last_month": {
"type": "string",
"format": "date",
"description": "The latest budget month"
},
"name": {
"type": "string"
}
}
}
},
"default_budget": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"accounts": {
"type": "array",
"description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)",
"items": {
"type": "object",
"required": [
"id",
"name",
"type",
"on_budget",
"closed",
"balance",
"cleared_balance",
"uncleared_balance",
"transfer_payee_id",
"deleted"
],
"properties": {
"balance": {
"type": "integer",
"format": "int64",
"description": "The current balance of the account in milliunits format"
},
"cleared_balance": {
"type": "integer",
"format": "int64",
"description": "The current cleared balance of the account in milliunits format"
},
"closed": {
"type": "boolean",
"description": "Whether this account is closed or not"
},
"debt_escrow_amounts": {
"type": "object"
},
"debt_interest_rates": {
"type": "object"
},
"debt_minimum_payments": {
"type": "object"
},
"debt_original_balance": {
"type": "integer",
"format": "int64",
"description": "The original debt/loan account balance, specified in milliunits format."
},
"deleted": {
"type": "boolean",
"description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."
},
"direct_import_in_error": {
"type": "boolean",
"description": "If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true."
},
"direct_import_linked": {
"type": "boolean",
"description": "Whether or not the account is linked to a financial institution for automatic transaction import."
},
"id": {
"type": "string",
"format": "uuid"
},
"last_reconciled_at": {
"type": "string",
"format": "date-time",
"description": "A date/time specifying when the account was last reconciled."
},
"name": {
"type": "string"
},
"note": {
"type": "string"
},
"on_budget": {
"type": "boolean",
"description": "Whether this account is on budget or not"
},
"transfer_payee_id": {
"type": "string",
"format": "uuid",
"description": "The payee id which should be used when transferring to this account"
},
"type": {
"type": "string",
"description": "The type of account",
"enum": [
"checking",
"savings",
"cash",
"creditCard",
"lineOfCredit",
"otherAsset",
"otherLiability",
"mortgage",
"autoLoan",
"studentLoan",
"personalLoan",
"medicalDebt",
"otherDebt"
]
},
"uncleared_balance": {
"type": "integer",
"format": "int64",
"description": "The current uncleared balance of the account in milliunits format"
}
}
}
},
"currency_format": {
"type": "object",
"description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null.",
"required": [
"currency_symbol",
"decimal_digits",
"decimal_separator",
"display_symbol",
"example_format",
"group_separator",
"iso_code",
"symbol_first"
],
"properties": {
"currency_symbol": {
"type": "string"
},
"decimal_digits": {
"type": "integer",
"format": "int32"
},
"decimal_separator": {
"type": "string"
},
"display_symbol": {
"type": "boolean"
},
"example_format": {
"type": "string"
},
"group_separator": {
"type": "string"
},
"iso_code": {
"type": "string"
},
"symbol_first": {
"type": "boolean"
}
}
},
"date_format": {
"type": "object",
"description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null.",
"required": [
"format"
],
"properties": {
"format": {
"type": "string"
}
}
},
"first_month": {
"type": "string",
"format": "date",
"description": "The earliest budget month"
},
"id": {
"type": "string",
"format": "uuid"
},
"last_modified_on": {
"type": "string",
"format": "date-time",
"description": "The last time any changes were made to the budget from either a web or mobile client"
},
"last_month": {
"type": "string",
"format": "date",
"description": "The latest budget month"
},
"name": {
"type": "string"
}
}
}
}
}
}
}