ynab 1.32.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 +438 -247
- package/dist/api.js +663 -329
- package/dist/browser/ynab.js +1 -2
- package/dist/esm/api.d.ts +438 -247
- package/dist/esm/api.js +566 -253
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/transactionsApi.d.ts +1 -1
- package/dist/esm/transactionsApi.js +3 -1
- package/dist/esm/utils.js +1 -1
- package/dist/index.js +1 -1
- package/dist/transactionsApi.d.ts +1 -1
- package/package.json +4 -4
package/dist/api.d.ts
CHANGED
|
@@ -800,6 +800,12 @@ export interface HybridTransactionsResponseData {
|
|
|
800
800
|
* @memberof HybridTransactionsResponseData
|
|
801
801
|
*/
|
|
802
802
|
transactions: Array<HybridTransaction>;
|
|
803
|
+
/**
|
|
804
|
+
* The knowledge of the server
|
|
805
|
+
* @type {number}
|
|
806
|
+
* @memberof HybridTransactionsResponseData
|
|
807
|
+
*/
|
|
808
|
+
server_knowledge?: number | null;
|
|
803
809
|
}
|
|
804
810
|
/**
|
|
805
811
|
*
|
|
@@ -914,6 +920,32 @@ export interface MonthSummary {
|
|
|
914
920
|
*/
|
|
915
921
|
deleted: boolean;
|
|
916
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
|
+
}
|
|
917
949
|
/**
|
|
918
950
|
*
|
|
919
951
|
* @export
|
|
@@ -1092,6 +1124,51 @@ export interface PayeesResponseData {
|
|
|
1092
1124
|
*/
|
|
1093
1125
|
server_knowledge: number;
|
|
1094
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
|
+
}
|
|
1095
1172
|
/**
|
|
1096
1173
|
*
|
|
1097
1174
|
* @export
|
|
@@ -1117,19 +1194,6 @@ export interface SaveAccount {
|
|
|
1117
1194
|
*/
|
|
1118
1195
|
balance: number;
|
|
1119
1196
|
}
|
|
1120
|
-
/**
|
|
1121
|
-
*
|
|
1122
|
-
* @export
|
|
1123
|
-
* @interface SaveAccountWrapper
|
|
1124
|
-
*/
|
|
1125
|
-
export interface SaveAccountWrapper {
|
|
1126
|
-
/**
|
|
1127
|
-
*
|
|
1128
|
-
* @type {SaveAccount}
|
|
1129
|
-
* @memberof SaveAccountWrapper
|
|
1130
|
-
*/
|
|
1131
|
-
account: SaveAccount;
|
|
1132
|
-
}
|
|
1133
1197
|
/**
|
|
1134
1198
|
*
|
|
1135
1199
|
* @export
|
|
@@ -1175,19 +1239,6 @@ export interface SaveMonthCategory {
|
|
|
1175
1239
|
*/
|
|
1176
1240
|
budgeted: number;
|
|
1177
1241
|
}
|
|
1178
|
-
/**
|
|
1179
|
-
*
|
|
1180
|
-
* @export
|
|
1181
|
-
* @interface SaveMonthCategoryWrapper
|
|
1182
|
-
*/
|
|
1183
|
-
export interface SaveMonthCategoryWrapper {
|
|
1184
|
-
/**
|
|
1185
|
-
*
|
|
1186
|
-
* @type {SaveMonthCategory}
|
|
1187
|
-
* @memberof SaveMonthCategoryWrapper
|
|
1188
|
-
*/
|
|
1189
|
-
category: SaveMonthCategory;
|
|
1190
|
-
}
|
|
1191
1242
|
/**
|
|
1192
1243
|
*
|
|
1193
1244
|
* @export
|
|
@@ -1228,87 +1279,87 @@ export interface SaveSubTransaction {
|
|
|
1228
1279
|
/**
|
|
1229
1280
|
*
|
|
1230
1281
|
* @export
|
|
1231
|
-
* @interface
|
|
1282
|
+
* @interface SaveTransactionWithOptionalFields
|
|
1232
1283
|
*/
|
|
1233
|
-
export interface
|
|
1284
|
+
export interface SaveTransactionWithOptionalFields {
|
|
1234
1285
|
/**
|
|
1235
1286
|
*
|
|
1236
1287
|
* @type {string}
|
|
1237
|
-
* @memberof
|
|
1288
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1238
1289
|
*/
|
|
1239
|
-
account_id
|
|
1290
|
+
account_id?: string | null;
|
|
1240
1291
|
/**
|
|
1241
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.
|
|
1242
1293
|
* @type {string}
|
|
1243
|
-
* @memberof
|
|
1294
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1244
1295
|
*/
|
|
1245
|
-
date
|
|
1296
|
+
date?: string | null;
|
|
1246
1297
|
/**
|
|
1247
1298
|
* The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
|
|
1248
1299
|
* @type {number}
|
|
1249
|
-
* @memberof
|
|
1300
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1250
1301
|
*/
|
|
1251
|
-
amount
|
|
1302
|
+
amount?: number | null;
|
|
1252
1303
|
/**
|
|
1253
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.
|
|
1254
1305
|
* @type {string}
|
|
1255
|
-
* @memberof
|
|
1306
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1256
1307
|
*/
|
|
1257
1308
|
payee_id?: string | null;
|
|
1258
1309
|
/**
|
|
1259
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.
|
|
1260
1311
|
* @type {string}
|
|
1261
|
-
* @memberof
|
|
1312
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1262
1313
|
*/
|
|
1263
1314
|
payee_name?: string | null;
|
|
1264
1315
|
/**
|
|
1265
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.
|
|
1266
1317
|
* @type {string}
|
|
1267
|
-
* @memberof
|
|
1318
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1268
1319
|
*/
|
|
1269
1320
|
category_id?: string | null;
|
|
1270
1321
|
/**
|
|
1271
1322
|
*
|
|
1272
1323
|
* @type {string}
|
|
1273
|
-
* @memberof
|
|
1324
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1274
1325
|
*/
|
|
1275
1326
|
memo?: string | null;
|
|
1276
1327
|
/**
|
|
1277
1328
|
* The cleared status of the transaction
|
|
1278
1329
|
* @type {string}
|
|
1279
|
-
* @memberof
|
|
1330
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1280
1331
|
*/
|
|
1281
|
-
cleared?:
|
|
1332
|
+
cleared?: SaveTransactionWithOptionalFields.ClearedEnum | null;
|
|
1282
1333
|
/**
|
|
1283
1334
|
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
1284
1335
|
* @type {boolean}
|
|
1285
|
-
* @memberof
|
|
1336
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1286
1337
|
*/
|
|
1287
1338
|
approved?: boolean | null;
|
|
1288
1339
|
/**
|
|
1289
1340
|
* The transaction flag
|
|
1290
1341
|
* @type {string}
|
|
1291
|
-
* @memberof
|
|
1342
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1292
1343
|
*/
|
|
1293
|
-
flag_color?:
|
|
1344
|
+
flag_color?: SaveTransactionWithOptionalFields.FlagColorEnum | null;
|
|
1294
1345
|
/**
|
|
1295
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).
|
|
1296
1347
|
* @type {string}
|
|
1297
|
-
* @memberof
|
|
1348
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1298
1349
|
*/
|
|
1299
1350
|
import_id?: string | null;
|
|
1300
1351
|
/**
|
|
1301
1352
|
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
1302
1353
|
* @type {Array<SaveSubTransaction>}
|
|
1303
|
-
* @memberof
|
|
1354
|
+
* @memberof SaveTransactionWithOptionalFields
|
|
1304
1355
|
*/
|
|
1305
1356
|
subtransactions?: Array<SaveSubTransaction> | null;
|
|
1306
1357
|
}
|
|
1307
1358
|
/**
|
|
1308
1359
|
* @export
|
|
1309
|
-
* @namespace
|
|
1360
|
+
* @namespace SaveTransactionWithOptionalFields
|
|
1310
1361
|
*/
|
|
1311
|
-
export declare namespace
|
|
1362
|
+
export declare namespace SaveTransactionWithOptionalFields {
|
|
1312
1363
|
/**
|
|
1313
1364
|
* @export
|
|
1314
1365
|
* @enum {string}
|
|
@@ -1331,19 +1382,6 @@ export declare namespace SaveTransaction {
|
|
|
1331
1382
|
Purple
|
|
1332
1383
|
}
|
|
1333
1384
|
}
|
|
1334
|
-
/**
|
|
1335
|
-
*
|
|
1336
|
-
* @export
|
|
1337
|
-
* @interface SaveTransactionWrapper
|
|
1338
|
-
*/
|
|
1339
|
-
export interface SaveTransactionWrapper {
|
|
1340
|
-
/**
|
|
1341
|
-
*
|
|
1342
|
-
* @type {SaveTransaction}
|
|
1343
|
-
* @memberof SaveTransactionWrapper
|
|
1344
|
-
*/
|
|
1345
|
-
transaction: SaveTransaction;
|
|
1346
|
-
}
|
|
1347
1385
|
/**
|
|
1348
1386
|
*
|
|
1349
1387
|
* @export
|
|
@@ -1394,25 +1432,6 @@ export interface SaveTransactionsResponseData {
|
|
|
1394
1432
|
*/
|
|
1395
1433
|
server_knowledge: number;
|
|
1396
1434
|
}
|
|
1397
|
-
/**
|
|
1398
|
-
*
|
|
1399
|
-
* @export
|
|
1400
|
-
* @interface SaveTransactionsWrapper
|
|
1401
|
-
*/
|
|
1402
|
-
export interface SaveTransactionsWrapper {
|
|
1403
|
-
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @type {SaveTransaction}
|
|
1406
|
-
* @memberof SaveTransactionsWrapper
|
|
1407
|
-
*/
|
|
1408
|
-
transaction?: SaveTransaction | null;
|
|
1409
|
-
/**
|
|
1410
|
-
*
|
|
1411
|
-
* @type {Array<SaveTransaction>}
|
|
1412
|
-
* @memberof SaveTransactionsWrapper
|
|
1413
|
-
*/
|
|
1414
|
-
transactions?: Array<SaveTransaction> | null;
|
|
1415
|
-
}
|
|
1416
1435
|
/**
|
|
1417
1436
|
*
|
|
1418
1437
|
* @export
|
|
@@ -1826,11 +1845,23 @@ export interface TransactionSummary {
|
|
|
1826
1845
|
*/
|
|
1827
1846
|
matched_transaction_id?: string | null;
|
|
1828
1847
|
/**
|
|
1829
|
-
* If the
|
|
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'.
|
|
1830
1849
|
* @type {string}
|
|
1831
1850
|
* @memberof TransactionSummary
|
|
1832
1851
|
*/
|
|
1833
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;
|
|
1834
1865
|
/**
|
|
1835
1866
|
* Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
|
|
1836
1867
|
* @type {boolean}
|
|
@@ -1923,19 +1954,6 @@ export interface TransactionsResponseData {
|
|
|
1923
1954
|
*/
|
|
1924
1955
|
server_knowledge: number;
|
|
1925
1956
|
}
|
|
1926
|
-
/**
|
|
1927
|
-
*
|
|
1928
|
-
* @export
|
|
1929
|
-
* @interface UpdateTransactionsWrapper
|
|
1930
|
-
*/
|
|
1931
|
-
export interface UpdateTransactionsWrapper {
|
|
1932
|
-
/**
|
|
1933
|
-
*
|
|
1934
|
-
* @type {Array<UpdateTransaction>}
|
|
1935
|
-
* @memberof UpdateTransactionsWrapper
|
|
1936
|
-
*/
|
|
1937
|
-
transactions: Array<UpdateTransaction>;
|
|
1938
|
-
}
|
|
1939
1957
|
/**
|
|
1940
1958
|
*
|
|
1941
1959
|
* @export
|
|
@@ -2206,11 +2224,23 @@ export interface HybridTransaction {
|
|
|
2206
2224
|
*/
|
|
2207
2225
|
matched_transaction_id?: string | null;
|
|
2208
2226
|
/**
|
|
2209
|
-
* If the
|
|
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'.
|
|
2210
2228
|
* @type {string}
|
|
2211
2229
|
* @memberof HybridTransaction
|
|
2212
2230
|
*/
|
|
2213
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;
|
|
2214
2244
|
/**
|
|
2215
2245
|
* Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
|
|
2216
2246
|
* @type {boolean}
|
|
@@ -2344,6 +2374,224 @@ export interface MonthDetail {
|
|
|
2344
2374
|
*/
|
|
2345
2375
|
categories: Array<Category>;
|
|
2346
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
|
+
}
|
|
2347
2595
|
/**
|
|
2348
2596
|
*
|
|
2349
2597
|
* @export
|
|
@@ -2569,11 +2817,23 @@ export interface TransactionDetail {
|
|
|
2569
2817
|
*/
|
|
2570
2818
|
matched_transaction_id?: string | null;
|
|
2571
2819
|
/**
|
|
2572
|
-
* If the
|
|
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'.
|
|
2573
2821
|
* @type {string}
|
|
2574
2822
|
* @memberof TransactionDetail
|
|
2575
2823
|
*/
|
|
2576
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;
|
|
2577
2837
|
/**
|
|
2578
2838
|
* Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
|
|
2579
2839
|
* @type {boolean}
|
|
@@ -2632,118 +2892,6 @@ export declare namespace TransactionDetail {
|
|
|
2632
2892
|
Purple
|
|
2633
2893
|
}
|
|
2634
2894
|
}
|
|
2635
|
-
/**
|
|
2636
|
-
*
|
|
2637
|
-
* @export
|
|
2638
|
-
* @interface UpdateTransaction
|
|
2639
|
-
*/
|
|
2640
|
-
export interface UpdateTransaction {
|
|
2641
|
-
/**
|
|
2642
|
-
*
|
|
2643
|
-
* @type {string}
|
|
2644
|
-
* @memberof UpdateTransaction
|
|
2645
|
-
*/
|
|
2646
|
-
account_id: string;
|
|
2647
|
-
/**
|
|
2648
|
-
* 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.
|
|
2649
|
-
* @type {string}
|
|
2650
|
-
* @memberof UpdateTransaction
|
|
2651
|
-
*/
|
|
2652
|
-
date: string;
|
|
2653
|
-
/**
|
|
2654
|
-
* The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
|
|
2655
|
-
* @type {number}
|
|
2656
|
-
* @memberof UpdateTransaction
|
|
2657
|
-
*/
|
|
2658
|
-
amount: number;
|
|
2659
|
-
/**
|
|
2660
|
-
* 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.
|
|
2661
|
-
* @type {string}
|
|
2662
|
-
* @memberof UpdateTransaction
|
|
2663
|
-
*/
|
|
2664
|
-
payee_id?: string | null;
|
|
2665
|
-
/**
|
|
2666
|
-
* 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.
|
|
2667
|
-
* @type {string}
|
|
2668
|
-
* @memberof UpdateTransaction
|
|
2669
|
-
*/
|
|
2670
|
-
payee_name?: string | null;
|
|
2671
|
-
/**
|
|
2672
|
-
* 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.
|
|
2673
|
-
* @type {string}
|
|
2674
|
-
* @memberof UpdateTransaction
|
|
2675
|
-
*/
|
|
2676
|
-
category_id?: string | null;
|
|
2677
|
-
/**
|
|
2678
|
-
*
|
|
2679
|
-
* @type {string}
|
|
2680
|
-
* @memberof UpdateTransaction
|
|
2681
|
-
*/
|
|
2682
|
-
memo?: string | null;
|
|
2683
|
-
/**
|
|
2684
|
-
* The cleared status of the transaction
|
|
2685
|
-
* @type {string}
|
|
2686
|
-
* @memberof UpdateTransaction
|
|
2687
|
-
*/
|
|
2688
|
-
cleared?: UpdateTransaction.ClearedEnum | null;
|
|
2689
|
-
/**
|
|
2690
|
-
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
2691
|
-
* @type {boolean}
|
|
2692
|
-
* @memberof UpdateTransaction
|
|
2693
|
-
*/
|
|
2694
|
-
approved?: boolean | null;
|
|
2695
|
-
/**
|
|
2696
|
-
* The transaction flag
|
|
2697
|
-
* @type {string}
|
|
2698
|
-
* @memberof UpdateTransaction
|
|
2699
|
-
*/
|
|
2700
|
-
flag_color?: UpdateTransaction.FlagColorEnum | null;
|
|
2701
|
-
/**
|
|
2702
|
-
* 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).
|
|
2703
|
-
* @type {string}
|
|
2704
|
-
* @memberof UpdateTransaction
|
|
2705
|
-
*/
|
|
2706
|
-
import_id?: string | null;
|
|
2707
|
-
/**
|
|
2708
|
-
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
2709
|
-
* @type {Array<SaveSubTransaction>}
|
|
2710
|
-
* @memberof UpdateTransaction
|
|
2711
|
-
*/
|
|
2712
|
-
subtransactions?: Array<SaveSubTransaction> | null;
|
|
2713
|
-
/**
|
|
2714
|
-
*
|
|
2715
|
-
* @type {string}
|
|
2716
|
-
* @memberof UpdateTransaction
|
|
2717
|
-
*/
|
|
2718
|
-
id: string;
|
|
2719
|
-
}
|
|
2720
|
-
/**
|
|
2721
|
-
* @export
|
|
2722
|
-
* @namespace UpdateTransaction
|
|
2723
|
-
*/
|
|
2724
|
-
export declare namespace UpdateTransaction {
|
|
2725
|
-
/**
|
|
2726
|
-
* @export
|
|
2727
|
-
* @enum {string}
|
|
2728
|
-
*/
|
|
2729
|
-
enum ClearedEnum {
|
|
2730
|
-
Cleared,
|
|
2731
|
-
Uncleared,
|
|
2732
|
-
Reconciled
|
|
2733
|
-
}
|
|
2734
|
-
/**
|
|
2735
|
-
* @export
|
|
2736
|
-
* @enum {string}
|
|
2737
|
-
*/
|
|
2738
|
-
enum FlagColorEnum {
|
|
2739
|
-
Red,
|
|
2740
|
-
Orange,
|
|
2741
|
-
Yellow,
|
|
2742
|
-
Green,
|
|
2743
|
-
Blue,
|
|
2744
|
-
Purple
|
|
2745
|
-
}
|
|
2746
|
-
}
|
|
2747
2895
|
/**
|
|
2748
2896
|
* AccountsApi - fetch parameter creator
|
|
2749
2897
|
* @export
|
|
@@ -2753,11 +2901,11 @@ export declare const AccountsApiFetchParamCreator: (configuration: Configuration
|
|
|
2753
2901
|
* Creates a new account
|
|
2754
2902
|
* @summary Create a new account
|
|
2755
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)
|
|
2756
|
-
* @param {
|
|
2904
|
+
* @param {PostAccountWrapper} data - The account to create.
|
|
2757
2905
|
* @param {*} [options] - Override http request options.
|
|
2758
2906
|
* @throws {RequiredError}
|
|
2759
2907
|
*/
|
|
2760
|
-
createAccount(budget_id: string, data:
|
|
2908
|
+
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): FetchArgs;
|
|
2761
2909
|
/**
|
|
2762
2910
|
* Returns a single account
|
|
2763
2911
|
* @summary Single account
|
|
@@ -2786,11 +2934,11 @@ export declare const AccountsApiFp: (configuration: Configuration) => {
|
|
|
2786
2934
|
* Creates a new account
|
|
2787
2935
|
* @summary Create a new account
|
|
2788
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)
|
|
2789
|
-
* @param {
|
|
2937
|
+
* @param {PostAccountWrapper} data - The account to create.
|
|
2790
2938
|
* @param {*} [options] - Override http request options.
|
|
2791
2939
|
* @throws {RequiredError}
|
|
2792
2940
|
*/
|
|
2793
|
-
createAccount(budget_id: string, data:
|
|
2941
|
+
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<AccountResponse & {
|
|
2794
2942
|
rateLimit: string | null;
|
|
2795
2943
|
}>;
|
|
2796
2944
|
/**
|
|
@@ -2825,11 +2973,11 @@ export declare const AccountsApiFactory: (configuration: Configuration) => {
|
|
|
2825
2973
|
* Creates a new account
|
|
2826
2974
|
* @summary Create a new account
|
|
2827
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)
|
|
2828
|
-
* @param {
|
|
2976
|
+
* @param {PostAccountWrapper} data - The account to create.
|
|
2829
2977
|
* @param {*} [options] - Override http request options.
|
|
2830
2978
|
* @throws {RequiredError}
|
|
2831
2979
|
*/
|
|
2832
|
-
createAccount(budget_id: string, data:
|
|
2980
|
+
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): Promise<AccountResponse & {
|
|
2833
2981
|
rateLimit: string | null;
|
|
2834
2982
|
}>;
|
|
2835
2983
|
/**
|
|
@@ -2866,12 +3014,12 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
2866
3014
|
* Creates a new account
|
|
2867
3015
|
* @summary Create a new account
|
|
2868
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)
|
|
2869
|
-
* @param {
|
|
3017
|
+
* @param {PostAccountWrapper} data - The account to create.
|
|
2870
3018
|
* @param {*} [options] - Override http request options.
|
|
2871
3019
|
* @throws {RequiredError}
|
|
2872
3020
|
* @memberof AccountsApi
|
|
2873
3021
|
*/
|
|
2874
|
-
createAccount(budget_id: string, data:
|
|
3022
|
+
createAccount(budget_id: string, data: PostAccountWrapper, options?: any): Promise<AccountResponse & {
|
|
2875
3023
|
rateLimit: string | null;
|
|
2876
3024
|
}>;
|
|
2877
3025
|
/**
|
|
@@ -3085,11 +3233,11 @@ export declare const CategoriesApiFetchParamCreator: (configuration: Configurati
|
|
|
3085
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).
|
|
3086
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))
|
|
3087
3235
|
* @param {string} category_id - The id of the category
|
|
3088
|
-
* @param {
|
|
3236
|
+
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3089
3237
|
* @param {*} [options] - Override http request options.
|
|
3090
3238
|
* @throws {RequiredError}
|
|
3091
3239
|
*/
|
|
3092
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data:
|
|
3240
|
+
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): FetchArgs;
|
|
3093
3241
|
};
|
|
3094
3242
|
/**
|
|
3095
3243
|
* CategoriesApi - functional programming interface
|
|
@@ -3136,11 +3284,11 @@ export declare const CategoriesApiFp: (configuration: Configuration) => {
|
|
|
3136
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).
|
|
3137
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))
|
|
3138
3286
|
* @param {string} category_id - The id of the category
|
|
3139
|
-
* @param {
|
|
3287
|
+
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3140
3288
|
* @param {*} [options] - Override http request options.
|
|
3141
3289
|
* @throws {RequiredError}
|
|
3142
3290
|
*/
|
|
3143
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data:
|
|
3291
|
+
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveCategoryResponse & {
|
|
3144
3292
|
rateLimit: string | null;
|
|
3145
3293
|
}>;
|
|
3146
3294
|
};
|
|
@@ -3189,11 +3337,11 @@ export declare const CategoriesApiFactory: (configuration: Configuration) => {
|
|
|
3189
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).
|
|
3190
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))
|
|
3191
3339
|
* @param {string} category_id - The id of the category
|
|
3192
|
-
* @param {
|
|
3340
|
+
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3193
3341
|
* @param {*} [options] - Override http request options.
|
|
3194
3342
|
* @throws {RequiredError}
|
|
3195
3343
|
*/
|
|
3196
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data:
|
|
3344
|
+
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
|
|
3197
3345
|
rateLimit: string | null;
|
|
3198
3346
|
}>;
|
|
3199
3347
|
};
|
|
@@ -3247,12 +3395,12 @@ export declare class CategoriesApi extends BaseAPI {
|
|
|
3247
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).
|
|
3248
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))
|
|
3249
3397
|
* @param {string} category_id - The id of the category
|
|
3250
|
-
* @param {
|
|
3398
|
+
* @param {PatchMonthCategoryWrapper} data - The category to update. Only `budgeted` amount can be updated and any other fields specified will be ignored.
|
|
3251
3399
|
* @param {*} [options] - Override http request options.
|
|
3252
3400
|
* @throws {RequiredError}
|
|
3253
3401
|
* @memberof CategoriesApi
|
|
3254
3402
|
*/
|
|
3255
|
-
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data:
|
|
3403
|
+
updateMonthCategory(budget_id: string, month: Date | string, category_id: string, data: PatchMonthCategoryWrapper, options?: any): Promise<SaveCategoryResponse & {
|
|
3256
3404
|
rateLimit: string | null;
|
|
3257
3405
|
}>;
|
|
3258
3406
|
}
|
|
@@ -3821,11 +3969,20 @@ export declare const TransactionsApiFetchParamCreator: (configuration: Configura
|
|
|
3821
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.
|
|
3822
3970
|
* @summary Create a single transaction or multiple transactions
|
|
3823
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).
|
|
3824
|
-
* @param {
|
|
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.
|
|
3825
3973
|
* @param {*} [options] - Override http request options.
|
|
3826
3974
|
* @throws {RequiredError}
|
|
3827
3975
|
*/
|
|
3828
|
-
createTransaction(budget_id: string, data:
|
|
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
|
|
3982
|
+
* @param {*} [options] - Override http request options.
|
|
3983
|
+
* @throws {RequiredError}
|
|
3984
|
+
*/
|
|
3985
|
+
deleteTransaction(budget_id: string, transaction_id: string, options?: any): FetchArgs;
|
|
3829
3986
|
/**
|
|
3830
3987
|
* Returns a single transaction
|
|
3831
3988
|
* @summary Single transaction
|
|
@@ -3895,20 +4052,20 @@ export declare const TransactionsApiFetchParamCreator: (configuration: Configura
|
|
|
3895
4052
|
* @summary Updates an existing transaction
|
|
3896
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).
|
|
3897
4054
|
* @param {string} transaction_id - The id of the transaction
|
|
3898
|
-
* @param {
|
|
4055
|
+
* @param {PutTransactionWrapper} data - The transaction to update
|
|
3899
4056
|
* @param {*} [options] - Override http request options.
|
|
3900
4057
|
* @throws {RequiredError}
|
|
3901
4058
|
*/
|
|
3902
|
-
updateTransaction(budget_id: string, transaction_id: string, data:
|
|
4059
|
+
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): FetchArgs;
|
|
3903
4060
|
/**
|
|
3904
4061
|
* Updates multiple transactions, by `id` or `import_id`.
|
|
3905
4062
|
* @summary Update multiple transactions
|
|
3906
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).
|
|
3907
|
-
* @param {
|
|
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.
|
|
3908
4065
|
* @param {*} [options] - Override http request options.
|
|
3909
4066
|
* @throws {RequiredError}
|
|
3910
4067
|
*/
|
|
3911
|
-
updateTransactions(budget_id: string, data:
|
|
4068
|
+
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): FetchArgs;
|
|
3912
4069
|
};
|
|
3913
4070
|
/**
|
|
3914
4071
|
* TransactionsApi - functional programming interface
|
|
@@ -3919,11 +4076,22 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
|
|
|
3919
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.
|
|
3920
4077
|
* @summary Create a single transaction or multiple transactions
|
|
3921
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).
|
|
3922
|
-
* @param {
|
|
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.
|
|
3923
4080
|
* @param {*} [options] - Override http request options.
|
|
3924
4081
|
* @throws {RequiredError}
|
|
3925
4082
|
*/
|
|
3926
|
-
createTransaction(budget_id: string, data:
|
|
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 & {
|
|
3927
4095
|
rateLimit: string | null;
|
|
3928
4096
|
}>;
|
|
3929
4097
|
/**
|
|
@@ -4007,22 +4175,22 @@ export declare const TransactionsApiFp: (configuration: Configuration) => {
|
|
|
4007
4175
|
* @summary Updates an existing transaction
|
|
4008
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).
|
|
4009
4177
|
* @param {string} transaction_id - The id of the transaction
|
|
4010
|
-
* @param {
|
|
4178
|
+
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4011
4179
|
* @param {*} [options] - Override http request options.
|
|
4012
4180
|
* @throws {RequiredError}
|
|
4013
4181
|
*/
|
|
4014
|
-
updateTransaction(budget_id: string, transaction_id: string, data:
|
|
4182
|
+
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<TransactionResponse & {
|
|
4015
4183
|
rateLimit: string | null;
|
|
4016
4184
|
}>;
|
|
4017
4185
|
/**
|
|
4018
4186
|
* Updates multiple transactions, by `id` or `import_id`.
|
|
4019
4187
|
* @summary Update multiple transactions
|
|
4020
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).
|
|
4021
|
-
* @param {
|
|
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.
|
|
4022
4190
|
* @param {*} [options] - Override http request options.
|
|
4023
4191
|
* @throws {RequiredError}
|
|
4024
4192
|
*/
|
|
4025
|
-
updateTransactions(budget_id: string, data:
|
|
4193
|
+
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): (fetchFunction?: FetchAPI | undefined) => Promise<SaveTransactionsResponse & {
|
|
4026
4194
|
rateLimit: string | null;
|
|
4027
4195
|
}>;
|
|
4028
4196
|
};
|
|
@@ -4035,11 +4203,22 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
|
|
|
4035
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.
|
|
4036
4204
|
* @summary Create a single transaction or multiple transactions
|
|
4037
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).
|
|
4038
|
-
* @param {
|
|
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.
|
|
4039
4207
|
* @param {*} [options] - Override http request options.
|
|
4040
4208
|
* @throws {RequiredError}
|
|
4041
4209
|
*/
|
|
4042
|
-
createTransaction(budget_id: string, data:
|
|
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 & {
|
|
4043
4222
|
rateLimit: string | null;
|
|
4044
4223
|
}>;
|
|
4045
4224
|
/**
|
|
@@ -4123,22 +4302,22 @@ export declare const TransactionsApiFactory: (configuration: Configuration) => {
|
|
|
4123
4302
|
* @summary Updates an existing transaction
|
|
4124
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).
|
|
4125
4304
|
* @param {string} transaction_id - The id of the transaction
|
|
4126
|
-
* @param {
|
|
4305
|
+
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4127
4306
|
* @param {*} [options] - Override http request options.
|
|
4128
4307
|
* @throws {RequiredError}
|
|
4129
4308
|
*/
|
|
4130
|
-
updateTransaction(budget_id: string, transaction_id: string, data:
|
|
4309
|
+
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): Promise<TransactionResponse & {
|
|
4131
4310
|
rateLimit: string | null;
|
|
4132
4311
|
}>;
|
|
4133
4312
|
/**
|
|
4134
4313
|
* Updates multiple transactions, by `id` or `import_id`.
|
|
4135
4314
|
* @summary Update multiple transactions
|
|
4136
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).
|
|
4137
|
-
* @param {
|
|
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.
|
|
4138
4317
|
* @param {*} [options] - Override http request options.
|
|
4139
4318
|
* @throws {RequiredError}
|
|
4140
4319
|
*/
|
|
4141
|
-
updateTransactions(budget_id: string, data:
|
|
4320
|
+
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
|
|
4142
4321
|
rateLimit: string | null;
|
|
4143
4322
|
}>;
|
|
4144
4323
|
};
|
|
@@ -4153,12 +4332,24 @@ export declare class TransactionsApi extends BaseAPI {
|
|
|
4153
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.
|
|
4154
4333
|
* @summary Create a single transaction or multiple transactions
|
|
4155
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).
|
|
4156
|
-
* @param {
|
|
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
|
|
4157
4348
|
* @param {*} [options] - Override http request options.
|
|
4158
4349
|
* @throws {RequiredError}
|
|
4159
4350
|
* @memberof TransactionsApi
|
|
4160
4351
|
*/
|
|
4161
|
-
|
|
4352
|
+
deleteTransaction(budget_id: string, transaction_id: string, options?: any): Promise<TransactionResponse & {
|
|
4162
4353
|
rateLimit: string | null;
|
|
4163
4354
|
}>;
|
|
4164
4355
|
/**
|
|
@@ -4248,24 +4439,24 @@ export declare class TransactionsApi extends BaseAPI {
|
|
|
4248
4439
|
* @summary Updates an existing transaction
|
|
4249
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).
|
|
4250
4441
|
* @param {string} transaction_id - The id of the transaction
|
|
4251
|
-
* @param {
|
|
4442
|
+
* @param {PutTransactionWrapper} data - The transaction to update
|
|
4252
4443
|
* @param {*} [options] - Override http request options.
|
|
4253
4444
|
* @throws {RequiredError}
|
|
4254
4445
|
* @memberof TransactionsApi
|
|
4255
4446
|
*/
|
|
4256
|
-
updateTransaction(budget_id: string, transaction_id: string, data:
|
|
4447
|
+
updateTransaction(budget_id: string, transaction_id: string, data: PutTransactionWrapper, options?: any): Promise<TransactionResponse & {
|
|
4257
4448
|
rateLimit: string | null;
|
|
4258
4449
|
}>;
|
|
4259
4450
|
/**
|
|
4260
4451
|
* Updates multiple transactions, by `id` or `import_id`.
|
|
4261
4452
|
* @summary Update multiple transactions
|
|
4262
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).
|
|
4263
|
-
* @param {
|
|
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.
|
|
4264
4455
|
* @param {*} [options] - Override http request options.
|
|
4265
4456
|
* @throws {RequiredError}
|
|
4266
4457
|
* @memberof TransactionsApi
|
|
4267
4458
|
*/
|
|
4268
|
-
updateTransactions(budget_id: string, data:
|
|
4459
|
+
updateTransactions(budget_id: string, data: PatchTransactionsWrapper, options?: any): Promise<SaveTransactionsResponse & {
|
|
4269
4460
|
rateLimit: string | null;
|
|
4270
4461
|
}>;
|
|
4271
4462
|
}
|