ynab 1.42.0 → 1.43.0

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/dist/api.d.ts CHANGED
@@ -920,6 +920,32 @@ export interface MonthSummary {
920
920
  */
921
921
  deleted: boolean;
922
922
  }
923
+ /**
924
+ *
925
+ * @export
926
+ * @interface PatchMonthCategoryWrapper
927
+ */
928
+ export interface PatchMonthCategoryWrapper {
929
+ /**
930
+ *
931
+ * @type {SaveMonthCategory}
932
+ * @memberof PatchMonthCategoryWrapper
933
+ */
934
+ category: SaveMonthCategory;
935
+ }
936
+ /**
937
+ *
938
+ * @export
939
+ * @interface PatchTransactionsWrapper
940
+ */
941
+ export interface PatchTransactionsWrapper {
942
+ /**
943
+ *
944
+ * @type {Array<SaveTransactionWithId>}
945
+ * @memberof PatchTransactionsWrapper
946
+ */
947
+ transactions: Array<SaveTransactionWithId>;
948
+ }
923
949
  /**
924
950
  *
925
951
  * @export
@@ -1098,6 +1124,51 @@ export interface PayeesResponseData {
1098
1124
  */
1099
1125
  server_knowledge: number;
1100
1126
  }
1127
+ /**
1128
+ *
1129
+ * @export
1130
+ * @interface PostAccountWrapper
1131
+ */
1132
+ export interface PostAccountWrapper {
1133
+ /**
1134
+ *
1135
+ * @type {SaveAccount}
1136
+ * @memberof PostAccountWrapper
1137
+ */
1138
+ account: SaveAccount;
1139
+ }
1140
+ /**
1141
+ *
1142
+ * @export
1143
+ * @interface PostTransactionsWrapper
1144
+ */
1145
+ export interface PostTransactionsWrapper {
1146
+ /**
1147
+ *
1148
+ * @type {SaveTransaction}
1149
+ * @memberof PostTransactionsWrapper
1150
+ */
1151
+ transaction?: SaveTransaction | null;
1152
+ /**
1153
+ *
1154
+ * @type {Array<SaveTransaction>}
1155
+ * @memberof PostTransactionsWrapper
1156
+ */
1157
+ transactions?: Array<SaveTransaction> | null;
1158
+ }
1159
+ /**
1160
+ *
1161
+ * @export
1162
+ * @interface PutTransactionWrapper
1163
+ */
1164
+ export interface PutTransactionWrapper {
1165
+ /**
1166
+ *
1167
+ * @type {SaveTransaction}
1168
+ * @memberof PutTransactionWrapper
1169
+ */
1170
+ transaction: SaveTransaction;
1171
+ }
1101
1172
  /**
1102
1173
  *
1103
1174
  * @export
@@ -1123,19 +1194,6 @@ export interface SaveAccount {
1123
1194
  */
1124
1195
  balance: number;
1125
1196
  }
1126
- /**
1127
- *
1128
- * @export
1129
- * @interface SaveAccountWrapper
1130
- */
1131
- export interface SaveAccountWrapper {
1132
- /**
1133
- *
1134
- * @type {SaveAccount}
1135
- * @memberof SaveAccountWrapper
1136
- */
1137
- account: SaveAccount;
1138
- }
1139
1197
  /**
1140
1198
  *
1141
1199
  * @export
@@ -1181,19 +1239,6 @@ export interface SaveMonthCategory {
1181
1239
  */
1182
1240
  budgeted: number;
1183
1241
  }
1184
- /**
1185
- *
1186
- * @export
1187
- * @interface SaveMonthCategoryWrapper
1188
- */
1189
- export interface SaveMonthCategoryWrapper {
1190
- /**
1191
- *
1192
- * @type {SaveMonthCategory}
1193
- * @memberof SaveMonthCategoryWrapper
1194
- */
1195
- category: SaveMonthCategory;
1196
- }
1197
1242
  /**
1198
1243
  *
1199
1244
  * @export
@@ -1234,87 +1279,87 @@ export interface SaveSubTransaction {
1234
1279
  /**
1235
1280
  *
1236
1281
  * @export
1237
- * @interface SaveTransaction
1282
+ * @interface SaveTransactionWithOptionalFields
1238
1283
  */
1239
- export interface SaveTransaction {
1284
+ export interface SaveTransactionWithOptionalFields {
1240
1285
  /**
1241
1286
  *
1242
1287
  * @type {string}
1243
- * @memberof SaveTransaction
1288
+ * @memberof SaveTransactionWithOptionalFields
1244
1289
  */
1245
- account_id: string;
1290
+ account_id?: string | null;
1246
1291
  /**
1247
1292
  * The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
1248
1293
  * @type {string}
1249
- * @memberof SaveTransaction
1294
+ * @memberof SaveTransactionWithOptionalFields
1250
1295
  */
1251
- date: string;
1296
+ date?: string | null;
1252
1297
  /**
1253
1298
  * The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
1254
1299
  * @type {number}
1255
- * @memberof SaveTransaction
1300
+ * @memberof SaveTransactionWithOptionalFields
1256
1301
  */
1257
- amount: number;
1302
+ amount?: number | null;
1258
1303
  /**
1259
1304
  * The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
1260
1305
  * @type {string}
1261
- * @memberof SaveTransaction
1306
+ * @memberof SaveTransactionWithOptionalFields
1262
1307
  */
1263
1308
  payee_id?: string | null;
1264
1309
  /**
1265
1310
  * The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
1266
1311
  * @type {string}
1267
- * @memberof SaveTransaction
1312
+ * @memberof SaveTransactionWithOptionalFields
1268
1313
  */
1269
1314
  payee_name?: string | null;
1270
1315
  /**
1271
1316
  * The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
1272
1317
  * @type {string}
1273
- * @memberof SaveTransaction
1318
+ * @memberof SaveTransactionWithOptionalFields
1274
1319
  */
1275
1320
  category_id?: string | null;
1276
1321
  /**
1277
1322
  *
1278
1323
  * @type {string}
1279
- * @memberof SaveTransaction
1324
+ * @memberof SaveTransactionWithOptionalFields
1280
1325
  */
1281
1326
  memo?: string | null;
1282
1327
  /**
1283
1328
  * The cleared status of the transaction
1284
1329
  * @type {string}
1285
- * @memberof SaveTransaction
1330
+ * @memberof SaveTransactionWithOptionalFields
1286
1331
  */
1287
- cleared?: SaveTransaction.ClearedEnum | null;
1332
+ cleared?: SaveTransactionWithOptionalFields.ClearedEnum | null;
1288
1333
  /**
1289
1334
  * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
1290
1335
  * @type {boolean}
1291
- * @memberof SaveTransaction
1336
+ * @memberof SaveTransactionWithOptionalFields
1292
1337
  */
1293
1338
  approved?: boolean | null;
1294
1339
  /**
1295
1340
  * The transaction flag
1296
1341
  * @type {string}
1297
- * @memberof SaveTransaction
1342
+ * @memberof SaveTransactionWithOptionalFields
1298
1343
  */
1299
- flag_color?: SaveTransaction.FlagColorEnum | null;
1344
+ flag_color?: SaveTransactionWithOptionalFields.FlagColorEnum | null;
1300
1345
  /**
1301
1346
  * If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
1302
1347
  * @type {string}
1303
- * @memberof SaveTransaction
1348
+ * @memberof SaveTransactionWithOptionalFields
1304
1349
  */
1305
1350
  import_id?: string | null;
1306
1351
  /**
1307
1352
  * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
1308
1353
  * @type {Array<SaveSubTransaction>}
1309
- * @memberof SaveTransaction
1354
+ * @memberof SaveTransactionWithOptionalFields
1310
1355
  */
1311
1356
  subtransactions?: Array<SaveSubTransaction> | null;
1312
1357
  }
1313
1358
  /**
1314
1359
  * @export
1315
- * @namespace SaveTransaction
1360
+ * @namespace SaveTransactionWithOptionalFields
1316
1361
  */
1317
- export declare namespace SaveTransaction {
1362
+ export declare namespace SaveTransactionWithOptionalFields {
1318
1363
  /**
1319
1364
  * @export
1320
1365
  * @enum {string}
@@ -1337,19 +1382,6 @@ export declare namespace SaveTransaction {
1337
1382
  Purple
1338
1383
  }
1339
1384
  }
1340
- /**
1341
- *
1342
- * @export
1343
- * @interface SaveTransactionWrapper
1344
- */
1345
- export interface SaveTransactionWrapper {
1346
- /**
1347
- *
1348
- * @type {SaveTransaction}
1349
- * @memberof SaveTransactionWrapper
1350
- */
1351
- transaction: SaveTransaction;
1352
- }
1353
1385
  /**
1354
1386
  *
1355
1387
  * @export
@@ -1400,25 +1432,6 @@ export interface SaveTransactionsResponseData {
1400
1432
  */
1401
1433
  server_knowledge: number;
1402
1434
  }
1403
- /**
1404
- *
1405
- * @export
1406
- * @interface SaveTransactionsWrapper
1407
- */
1408
- export interface SaveTransactionsWrapper {
1409
- /**
1410
- *
1411
- * @type {SaveTransaction}
1412
- * @memberof SaveTransactionsWrapper
1413
- */
1414
- transaction?: SaveTransaction | null;
1415
- /**
1416
- *
1417
- * @type {Array<SaveTransaction>}
1418
- * @memberof SaveTransactionsWrapper
1419
- */
1420
- transactions?: Array<SaveTransaction> | null;
1421
- }
1422
1435
  /**
1423
1436
  *
1424
1437
  * @export
@@ -1832,11 +1845,23 @@ export interface TransactionSummary {
1832
1845
  */
1833
1846
  matched_transaction_id?: string | null;
1834
1847
  /**
1835
- * If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
1848
+ * If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
1836
1849
  * @type {string}
1837
1850
  * @memberof TransactionSummary
1838
1851
  */
1839
1852
  import_id?: string | null;
1853
+ /**
1854
+ * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
1855
+ * @type {string}
1856
+ * @memberof TransactionSummary
1857
+ */
1858
+ import_payee_name?: string | null;
1859
+ /**
1860
+ * If the transaction was imported, the original payee name as it appeared on the statement
1861
+ * @type {string}
1862
+ * @memberof TransactionSummary
1863
+ */
1864
+ import_payee_name_original?: string | null;
1840
1865
  /**
1841
1866
  * Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
1842
1867
  * @type {boolean}
@@ -1929,19 +1954,6 @@ export interface TransactionsResponseData {
1929
1954
  */
1930
1955
  server_knowledge: number;
1931
1956
  }
1932
- /**
1933
- *
1934
- * @export
1935
- * @interface UpdateTransactionsWrapper
1936
- */
1937
- export interface UpdateTransactionsWrapper {
1938
- /**
1939
- *
1940
- * @type {Array<UpdateTransaction>}
1941
- * @memberof UpdateTransactionsWrapper
1942
- */
1943
- transactions: Array<UpdateTransaction>;
1944
- }
1945
1957
  /**
1946
1958
  *
1947
1959
  * @export
@@ -2212,11 +2224,23 @@ export interface HybridTransaction {
2212
2224
  */
2213
2225
  matched_transaction_id?: string | null;
2214
2226
  /**
2215
- * If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
2227
+ * If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
2216
2228
  * @type {string}
2217
2229
  * @memberof HybridTransaction
2218
2230
  */
2219
2231
  import_id?: string | null;
2232
+ /**
2233
+ * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
2234
+ * @type {string}
2235
+ * @memberof HybridTransaction
2236
+ */
2237
+ import_payee_name?: string | null;
2238
+ /**
2239
+ * If the transaction was imported, the original payee name as it appeared on the statement
2240
+ * @type {string}
2241
+ * @memberof HybridTransaction
2242
+ */
2243
+ import_payee_name_original?: string | null;
2220
2244
  /**
2221
2245
  * Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
2222
2246
  * @type {boolean}
@@ -2350,6 +2374,224 @@ export interface MonthDetail {
2350
2374
  */
2351
2375
  categories: Array<Category>;
2352
2376
  }
2377
+ /**
2378
+ *
2379
+ * @export
2380
+ * @interface SaveTransaction
2381
+ */
2382
+ export interface SaveTransaction {
2383
+ /**
2384
+ *
2385
+ * @type {string}
2386
+ * @memberof SaveTransaction
2387
+ */
2388
+ account_id?: string | null;
2389
+ /**
2390
+ * The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
2391
+ * @type {string}
2392
+ * @memberof SaveTransaction
2393
+ */
2394
+ date?: string | null;
2395
+ /**
2396
+ * The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
2397
+ * @type {number}
2398
+ * @memberof SaveTransaction
2399
+ */
2400
+ amount?: number | null;
2401
+ /**
2402
+ * The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
2403
+ * @type {string}
2404
+ * @memberof SaveTransaction
2405
+ */
2406
+ payee_id?: string | null;
2407
+ /**
2408
+ * The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
2409
+ * @type {string}
2410
+ * @memberof SaveTransaction
2411
+ */
2412
+ payee_name?: string | null;
2413
+ /**
2414
+ * The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
2415
+ * @type {string}
2416
+ * @memberof SaveTransaction
2417
+ */
2418
+ category_id?: string | null;
2419
+ /**
2420
+ *
2421
+ * @type {string}
2422
+ * @memberof SaveTransaction
2423
+ */
2424
+ memo?: string | null;
2425
+ /**
2426
+ * The cleared status of the transaction
2427
+ * @type {string}
2428
+ * @memberof SaveTransaction
2429
+ */
2430
+ cleared?: SaveTransaction.ClearedEnum | null;
2431
+ /**
2432
+ * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
2433
+ * @type {boolean}
2434
+ * @memberof SaveTransaction
2435
+ */
2436
+ approved?: boolean | null;
2437
+ /**
2438
+ * The transaction flag
2439
+ * @type {string}
2440
+ * @memberof SaveTransaction
2441
+ */
2442
+ flag_color?: SaveTransaction.FlagColorEnum | null;
2443
+ /**
2444
+ * If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
2445
+ * @type {string}
2446
+ * @memberof SaveTransaction
2447
+ */
2448
+ import_id?: string | null;
2449
+ /**
2450
+ * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
2451
+ * @type {Array<SaveSubTransaction>}
2452
+ * @memberof SaveTransaction
2453
+ */
2454
+ subtransactions?: Array<SaveSubTransaction> | null;
2455
+ }
2456
+ /**
2457
+ * @export
2458
+ * @namespace SaveTransaction
2459
+ */
2460
+ export declare namespace SaveTransaction {
2461
+ /**
2462
+ * @export
2463
+ * @enum {string}
2464
+ */
2465
+ enum ClearedEnum {
2466
+ Cleared,
2467
+ Uncleared,
2468
+ Reconciled
2469
+ }
2470
+ /**
2471
+ * @export
2472
+ * @enum {string}
2473
+ */
2474
+ enum FlagColorEnum {
2475
+ Red,
2476
+ Orange,
2477
+ Yellow,
2478
+ Green,
2479
+ Blue,
2480
+ Purple
2481
+ }
2482
+ }
2483
+ /**
2484
+ *
2485
+ * @export
2486
+ * @interface SaveTransactionWithId
2487
+ */
2488
+ export interface SaveTransactionWithId {
2489
+ /**
2490
+ *
2491
+ * @type {string}
2492
+ * @memberof SaveTransactionWithId
2493
+ */
2494
+ account_id?: string | null;
2495
+ /**
2496
+ * The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
2497
+ * @type {string}
2498
+ * @memberof SaveTransactionWithId
2499
+ */
2500
+ date?: string | null;
2501
+ /**
2502
+ * The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
2503
+ * @type {number}
2504
+ * @memberof SaveTransactionWithId
2505
+ */
2506
+ amount?: number | null;
2507
+ /**
2508
+ * The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
2509
+ * @type {string}
2510
+ * @memberof SaveTransactionWithId
2511
+ */
2512
+ payee_id?: string | null;
2513
+ /**
2514
+ * The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
2515
+ * @type {string}
2516
+ * @memberof SaveTransactionWithId
2517
+ */
2518
+ payee_name?: string | null;
2519
+ /**
2520
+ * The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
2521
+ * @type {string}
2522
+ * @memberof SaveTransactionWithId
2523
+ */
2524
+ category_id?: string | null;
2525
+ /**
2526
+ *
2527
+ * @type {string}
2528
+ * @memberof SaveTransactionWithId
2529
+ */
2530
+ memo?: string | null;
2531
+ /**
2532
+ * The cleared status of the transaction
2533
+ * @type {string}
2534
+ * @memberof SaveTransactionWithId
2535
+ */
2536
+ cleared?: SaveTransactionWithId.ClearedEnum | null;
2537
+ /**
2538
+ * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
2539
+ * @type {boolean}
2540
+ * @memberof SaveTransactionWithId
2541
+ */
2542
+ approved?: boolean | null;
2543
+ /**
2544
+ * The transaction flag
2545
+ * @type {string}
2546
+ * @memberof SaveTransactionWithId
2547
+ */
2548
+ flag_color?: SaveTransactionWithId.FlagColorEnum | null;
2549
+ /**
2550
+ * If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
2551
+ * @type {string}
2552
+ * @memberof SaveTransactionWithId
2553
+ */
2554
+ import_id?: string | null;
2555
+ /**
2556
+ * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
2557
+ * @type {Array<SaveSubTransaction>}
2558
+ * @memberof SaveTransactionWithId
2559
+ */
2560
+ subtransactions?: Array<SaveSubTransaction> | null;
2561
+ /**
2562
+ *
2563
+ * @type {string}
2564
+ * @memberof SaveTransactionWithId
2565
+ */
2566
+ id?: string | null;
2567
+ }
2568
+ /**
2569
+ * @export
2570
+ * @namespace SaveTransactionWithId
2571
+ */
2572
+ export declare namespace SaveTransactionWithId {
2573
+ /**
2574
+ * @export
2575
+ * @enum {string}
2576
+ */
2577
+ enum ClearedEnum {
2578
+ Cleared,
2579
+ Uncleared,
2580
+ Reconciled
2581
+ }
2582
+ /**
2583
+ * @export
2584
+ * @enum {string}
2585
+ */
2586
+ enum FlagColorEnum {
2587
+ Red,
2588
+ Orange,
2589
+ Yellow,
2590
+ Green,
2591
+ Blue,
2592
+ Purple
2593
+ }
2594
+ }
2353
2595
  /**
2354
2596
  *
2355
2597
  * @export
@@ -2575,11 +2817,23 @@ export interface TransactionDetail {
2575
2817
  */
2576
2818
  matched_transaction_id?: string | null;
2577
2819
  /**
2578
- * If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
2820
+ * If the transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
2579
2821
  * @type {string}
2580
2822
  * @memberof TransactionDetail
2581
2823
  */
2582
2824
  import_id?: string | null;
2825
+ /**
2826
+ * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
2827
+ * @type {string}
2828
+ * @memberof TransactionDetail
2829
+ */
2830
+ import_payee_name?: string | null;
2831
+ /**
2832
+ * If the transaction was imported, the original payee name as it appeared on the statement
2833
+ * @type {string}
2834
+ * @memberof TransactionDetail
2835
+ */
2836
+ import_payee_name_original?: string | null;
2583
2837
  /**
2584
2838
  * Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
2585
2839
  * @type {boolean}
@@ -2638,118 +2892,6 @@ export declare namespace TransactionDetail {
2638
2892
  Purple
2639
2893
  }
2640
2894
  }
2641
- /**
2642
- *
2643
- * @export
2644
- * @interface UpdateTransaction
2645
- */
2646
- export interface UpdateTransaction {
2647
- /**
2648
- *
2649
- * @type {string}
2650
- * @memberof UpdateTransaction
2651
- */
2652
- account_id: string;
2653
- /**
2654
- * The transaction date in ISO format (e.g. 2016-12-01). Future dates (scheduled transactions) are not permitted. Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
2655
- * @type {string}
2656
- * @memberof UpdateTransaction
2657
- */
2658
- date: string;
2659
- /**
2660
- * The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
2661
- * @type {number}
2662
- * @memberof UpdateTransaction
2663
- */
2664
- amount: number;
2665
- /**
2666
- * The payee for the transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `tranfer_payee_id` on the account resource.
2667
- * @type {string}
2668
- * @memberof UpdateTransaction
2669
- */
2670
- payee_id?: string | null;
2671
- /**
2672
- * The payee name. If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
2673
- * @type {string}
2674
- * @memberof UpdateTransaction
2675
- */
2676
- payee_name?: string | null;
2677
- /**
2678
- * The category for the transaction. To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object. If an existing transaction is a split, the `category_id` cannot be changed. Credit Card Payment categories are not permitted and will be ignored if supplied.
2679
- * @type {string}
2680
- * @memberof UpdateTransaction
2681
- */
2682
- category_id?: string | null;
2683
- /**
2684
- *
2685
- * @type {string}
2686
- * @memberof UpdateTransaction
2687
- */
2688
- memo?: string | null;
2689
- /**
2690
- * The cleared status of the transaction
2691
- * @type {string}
2692
- * @memberof UpdateTransaction
2693
- */
2694
- cleared?: UpdateTransaction.ClearedEnum | null;
2695
- /**
2696
- * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
2697
- * @type {boolean}
2698
- * @memberof UpdateTransaction
2699
- */
2700
- approved?: boolean | null;
2701
- /**
2702
- * The transaction flag
2703
- * @type {string}
2704
- * @memberof UpdateTransaction
2705
- */
2706
- flag_color?: UpdateTransaction.FlagColorEnum | null;
2707
- /**
2708
- * If specified, the new transaction will be assigned this `import_id` and considered \"imported\". We will also attempt to match this imported transaction to an existing \"user-entered\" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a \"user-entered\" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
2709
- * @type {string}
2710
- * @memberof UpdateTransaction
2711
- */
2712
- import_id?: string | null;
2713
- /**
2714
- * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
2715
- * @type {Array<SaveSubTransaction>}
2716
- * @memberof UpdateTransaction
2717
- */
2718
- subtransactions?: Array<SaveSubTransaction> | null;
2719
- /**
2720
- *
2721
- * @type {string}
2722
- * @memberof UpdateTransaction
2723
- */
2724
- id: string;
2725
- }
2726
- /**
2727
- * @export
2728
- * @namespace UpdateTransaction
2729
- */
2730
- export declare namespace UpdateTransaction {
2731
- /**
2732
- * @export
2733
- * @enum {string}
2734
- */
2735
- enum ClearedEnum {
2736
- Cleared,
2737
- Uncleared,
2738
- Reconciled
2739
- }
2740
- /**
2741
- * @export
2742
- * @enum {string}
2743
- */
2744
- enum FlagColorEnum {
2745
- Red,
2746
- Orange,
2747
- Yellow,
2748
- Green,
2749
- Blue,
2750
- Purple
2751
- }
2752
- }
2753
2895
  /**
2754
2896
  * AccountsApi - fetch parameter creator
2755
2897
  * @export
@@ -2759,11 +2901,11 @@ export declare const AccountsApiFetchParamCreator: (configuration: Configuration
2759
2901
  * Creates a new account
2760
2902
  * @summary Create a new account
2761
2903
  * @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
2762
- * @param {SaveAccountWrapper} data - The account to create.
2904
+ * @param {PostAccountWrapper} data - The account to create.
2763
2905
  * @param {*} [options] - Override http request options.
2764
2906
  * @throws {RequiredError}
2765
2907
  */
2766
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): FetchArgs;
2908
+ createAccount(budget_id: string, data: PostAccountWrapper, options?: any): FetchArgs;
2767
2909
  /**
2768
2910
  * Returns a single account
2769
2911
  * @summary Single account
@@ -2792,11 +2934,11 @@ export declare const AccountsApiFp: (configuration: Configuration) => {
2792
2934
  * Creates a new account
2793
2935
  * @summary Create a new account
2794
2936
  * @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
2795
- * @param {SaveAccountWrapper} data - The account to create.
2937
+ * @param {PostAccountWrapper} data - The account to create.
2796
2938
  * @param {*} [options] - Override http request options.
2797
2939
  * @throws {RequiredError}
2798
2940
  */
2799
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
2941
+ createAccount(budget_id: string, data: PostAccountWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
2800
2942
  rateLimit: string | null;
2801
2943
  }>;
2802
2944
  /**
@@ -2831,11 +2973,11 @@ export declare const AccountsApiFactory: (configuration: Configuration) => {
2831
2973
  * Creates a new account
2832
2974
  * @summary Create a new account
2833
2975
  * @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
2834
- * @param {SaveAccountWrapper} data - The account to create.
2976
+ * @param {PostAccountWrapper} data - The account to create.
2835
2977
  * @param {*} [options] - Override http request options.
2836
2978
  * @throws {RequiredError}
2837
2979
  */
2838
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): Promise<AccountResponse & {
2980
+ createAccount(budget_id: string, data: PostAccountWrapper, options?: any): Promise<AccountResponse & {
2839
2981
  rateLimit: string | null;
2840
2982
  }>;
2841
2983
  /**
@@ -2872,12 +3014,12 @@ export declare class AccountsApi extends BaseAPI {
2872
3014
  * Creates a new account
2873
3015
  * @summary Create a new account
2874
3016
  * @param {string} budget_id - The id of the budget (\"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget)
2875
- * @param {SaveAccountWrapper} data - The account to create.
3017
+ * @param {PostAccountWrapper} data - The account to create.
2876
3018
  * @param {*} [options] - Override http request options.
2877
3019
  * @throws {RequiredError}
2878
3020
  * @memberof AccountsApi
2879
3021
  */
2880
- createAccount(budget_id: string, data: SaveAccountWrapper, options?: any): Promise<AccountResponse & {
3022
+ createAccount(budget_id: string, data: PostAccountWrapper, options?: any): Promise<AccountResponse & {
2881
3023
  rateLimit: string | null;
2882
3024
  }>;
2883
3025
  /**
@@ -3091,11 +3233,11 @@ export declare const CategoriesApiFetchParamCreator: (configuration: Configurati
3091
3233
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3092
3234
  * @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
3093
3235
  * @param {string} category_id - The id of the category
3094
- * @param {SaveMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3236
+ * @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3095
3237
  * @param {*} [options] - Override http request options.
3096
3238
  * @throws {RequiredError}
3097
3239
  */
3098
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): FetchArgs;
3240
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): FetchArgs;
3099
3241
  };
3100
3242
  /**
3101
3243
  * CategoriesApi - functional programming interface
@@ -3142,11 +3284,11 @@ export declare const CategoriesApiFp: (configuration: Configuration) => {
3142
3284
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3143
3285
  * @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
3144
3286
  * @param {string} category_id - The id of the category
3145
- * @param {SaveMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3287
+ * @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3146
3288
  * @param {*} [options] - Override http request options.
3147
3289
  * @throws {RequiredError}
3148
3290
  */
3149
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveCategoryResponse & {
3291
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveCategoryResponse & {
3150
3292
  rateLimit: string | null;
3151
3293
  }>;
3152
3294
  };
@@ -3195,11 +3337,11 @@ export declare const CategoriesApiFactory: (configuration: Configuration) => {
3195
3337
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3196
3338
  * @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
3197
3339
  * @param {string} category_id - The id of the category
3198
- * @param {SaveMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3340
+ * @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3199
3341
  * @param {*} [options] - Override http request options.
3200
3342
  * @throws {RequiredError}
3201
3343
  */
3202
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
3344
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
3203
3345
  rateLimit: string | null;
3204
3346
  }>;
3205
3347
  };
@@ -3253,12 +3395,12 @@ export declare class CategoriesApi extends BaseAPI {
3253
3395
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3254
3396
  * @param {Date} month - The budget month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC))
3255
3397
  * @param {string} category_id - The id of the category
3256
- * @param {SaveMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3398
+ * @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
3257
3399
  * @param {*} [options] - Override http request options.
3258
3400
  * @throws {RequiredError}
3259
3401
  * @memberof CategoriesApi
3260
3402
  */
3261
- updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: SaveMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
3403
+ updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
3262
3404
  rateLimit: string | null;
3263
3405
  }>;
3264
3406
  }
@@ -3827,11 +3969,20 @@ export declare const TransactionsApiFetchParamCreator: (configuration: Configura
3827
3969
  * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
3828
3970
  * @summary Create a single transaction or multiple transactions
3829
3971
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3830
- * @param {SaveTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
3972
+ * @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
3973
+ * @param {*} [options] - Override http request options.
3974
+ * @throws {RequiredError}
3975
+ */
3976
+ createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): FetchArgs;
3977
+ /**
3978
+ * Deletes a transaction
3979
+ * @summary Deletes an existing transaction
3980
+ * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3981
+ * @param {string} transaction_id - The id of the transaction
3831
3982
  * @param {*} [options] - Override http request options.
3832
3983
  * @throws {RequiredError}
3833
3984
  */
3834
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): FetchArgs;
3985
+ deleteTransaction(budget_id: string, transaction_id: string, options?: any): FetchArgs;
3835
3986
  /**
3836
3987
  * Returns a single transaction
3837
3988
  * @summary Single transaction
@@ -3901,20 +4052,20 @@ export declare const TransactionsApiFetchParamCreator: (configuration: Configura
3901
4052
  * @summary Updates an existing transaction
3902
4053
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3903
4054
  * @param {string} transaction_id - The id of the transaction
3904
- * @param {SaveTransactionWrapper} data - The transaction to update
4055
+ * @param {PutTransactionWrapper} data - The transaction to update
3905
4056
  * @param {*} [options] - Override http request options.
3906
4057
  * @throws {RequiredError}
3907
4058
  */
3908
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): FetchArgs;
4059
+ updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): FetchArgs;
3909
4060
  /**
3910
4061
  * Updates multiple transactions, by `id` or `import_id`.
3911
4062
  * @summary Update multiple transactions
3912
4063
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3913
- * @param {UpdateTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4064
+ * @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
3914
4065
  * @param {*} [options] - Override http request options.
3915
4066
  * @throws {RequiredError}
3916
4067
  */
3917
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): FetchArgs;
4068
+ updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): FetchArgs;
3918
4069
  };
3919
4070
  /**
3920
4071
  * TransactionsApi - functional programming interface
@@ -3925,11 +4076,22 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
3925
4076
  * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
3926
4077
  * @summary Create a single transaction or multiple transactions
3927
4078
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
3928
- * @param {SaveTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
4079
+ * @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
3929
4080
  * @param {*} [options] - Override http request options.
3930
4081
  * @throws {RequiredError}
3931
4082
  */
3932
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
4083
+ createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
4084
+ rateLimit: string | null;
4085
+ }>;
4086
+ /**
4087
+ * Deletes a transaction
4088
+ * @summary Deletes an existing transaction
4089
+ * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4090
+ * @param {string} transaction_id - The id of the transaction
4091
+ * @param {*} [options] - Override http request options.
4092
+ * @throws {RequiredError}
4093
+ */
4094
+ deleteTransaction(budget_id: string, transaction_id: string, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
3933
4095
  rateLimit: string | null;
3934
4096
  }>;
3935
4097
  /**
@@ -4013,22 +4175,22 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
4013
4175
  * @summary Updates an existing transaction
4014
4176
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4015
4177
  * @param {string} transaction_id - The id of the transaction
4016
- * @param {SaveTransactionWrapper} data - The transaction to update
4178
+ * @param {PutTransactionWrapper} data - The transaction to update
4017
4179
  * @param {*} [options] - Override http request options.
4018
4180
  * @throws {RequiredError}
4019
4181
  */
4020
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
4182
+ updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
4021
4183
  rateLimit: string | null;
4022
4184
  }>;
4023
4185
  /**
4024
4186
  * Updates multiple transactions, by `id` or `import_id`.
4025
4187
  * @summary Update multiple transactions
4026
4188
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4027
- * @param {UpdateTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4189
+ * @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4028
4190
  * @param {*} [options] - Override http request options.
4029
4191
  * @throws {RequiredError}
4030
4192
  */
4031
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
4193
+ updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
4032
4194
  rateLimit: string | null;
4033
4195
  }>;
4034
4196
  };
@@ -4041,11 +4203,22 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
4041
4203
  * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
4042
4204
  * @summary Create a single transaction or multiple transactions
4043
4205
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4044
- * @param {SaveTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
4206
+ * @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
4045
4207
  * @param {*} [options] - Override http request options.
4046
4208
  * @throws {RequiredError}
4047
4209
  */
4048
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4210
+ createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4211
+ rateLimit: string | null;
4212
+ }>;
4213
+ /**
4214
+ * Deletes a transaction
4215
+ * @summary Deletes an existing transaction
4216
+ * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4217
+ * @param {string} transaction_id - The id of the transaction
4218
+ * @param {*} [options] - Override http request options.
4219
+ * @throws {RequiredError}
4220
+ */
4221
+ deleteTransaction(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
4049
4222
  rateLimit: string | null;
4050
4223
  }>;
4051
4224
  /**
@@ -4129,22 +4302,22 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
4129
4302
  * @summary Updates an existing transaction
4130
4303
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4131
4304
  * @param {string} transaction_id - The id of the transaction
4132
- * @param {SaveTransactionWrapper} data - The transaction to update
4305
+ * @param {PutTransactionWrapper} data - The transaction to update
4133
4306
  * @param {*} [options] - Override http request options.
4134
4307
  * @throws {RequiredError}
4135
4308
  */
4136
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): Promise<TransactionResponse & {
4309
+ updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): Promise<TransactionResponse & {
4137
4310
  rateLimit: string | null;
4138
4311
  }>;
4139
4312
  /**
4140
4313
  * Updates multiple transactions, by `id` or `import_id`.
4141
4314
  * @summary Update multiple transactions
4142
4315
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4143
- * @param {UpdateTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4316
+ * @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4144
4317
  * @param {*} [options] - Override http request options.
4145
4318
  * @throws {RequiredError}
4146
4319
  */
4147
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4320
+ updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4148
4321
  rateLimit: string | null;
4149
4322
  }>;
4150
4323
  };
@@ -4159,12 +4332,24 @@ export declare class TransactionsApi extends BaseAPI {
4159
4332
  * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
4160
4333
  * @summary Create a single transaction or multiple transactions
4161
4334
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4162
- * @param {SaveTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
4335
+ * @param {PostTransactionsWrapper} data - The transaction or transactions to create. To create a single transaction you can specify a value for the `transaction` object and to create multiple transactions you can specify an array of `transactions`. It is expected that you will only provide a value for one of these objects.
4336
+ * @param {*} [options] - Override http request options.
4337
+ * @throws {RequiredError}
4338
+ * @memberof TransactionsApi
4339
+ */
4340
+ createTransaction(budget_id: string, data: PostTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4341
+ rateLimit: string | null;
4342
+ }>;
4343
+ /**
4344
+ * Deletes a transaction
4345
+ * @summary Deletes an existing transaction
4346
+ * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4347
+ * @param {string} transaction_id - The id of the transaction
4163
4348
  * @param {*} [options] - Override http request options.
4164
4349
  * @throws {RequiredError}
4165
4350
  * @memberof TransactionsApi
4166
4351
  */
4167
- createTransaction(budget_id: string, data: SaveTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4352
+ deleteTransaction(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
4168
4353
  rateLimit: string | null;
4169
4354
  }>;
4170
4355
  /**
@@ -4254,24 +4439,24 @@ export declare class TransactionsApi extends BaseAPI {
4254
4439
  * @summary Updates an existing transaction
4255
4440
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4256
4441
  * @param {string} transaction_id - The id of the transaction
4257
- * @param {SaveTransactionWrapper} data - The transaction to update
4442
+ * @param {PutTransactionWrapper} data - The transaction to update
4258
4443
  * @param {*} [options] - Override http request options.
4259
4444
  * @throws {RequiredError}
4260
4445
  * @memberof TransactionsApi
4261
4446
  */
4262
- updateTransaction(budget_id: string, transaction_id: string, data: SaveTransactionWrapper, options?: any): Promise<TransactionResponse & {
4447
+ updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): Promise<TransactionResponse & {
4263
4448
  rateLimit: string | null;
4264
4449
  }>;
4265
4450
  /**
4266
4451
  * Updates multiple transactions, by `id` or `import_id`.
4267
4452
  * @summary Update multiple transactions
4268
4453
  * @param {string} budget_id - The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.youneedabudget.com/#oauth-default-budget).
4269
- * @param {UpdateTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4454
+ * @param {PatchTransactionsWrapper} data - The transactions to update. Each transaction must have either an `id` or `import_id` specified. If `id` is specified as null an `import_id` value can be provided which will allow transaction(s) to be updated by their `import_id`. If an `id` is specified, it will always be used for lookup.
4270
4455
  * @param {*} [options] - Override http request options.
4271
4456
  * @throws {RequiredError}
4272
4457
  * @memberof TransactionsApi
4273
4458
  */
4274
- updateTransactions(budget_id: string, data: UpdateTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4459
+ updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
4275
4460
  rateLimit: string | null;
4276
4461
  }>;
4277
4462
  }