ynab 2.0.0 → 2.3.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/README.md +2 -2
- package/dist/apis/AccountsApi.d.ts +1 -1
- package/dist/apis/AccountsApi.js +1 -1
- package/dist/apis/BudgetsApi.d.ts +1 -1
- package/dist/apis/BudgetsApi.js +1 -1
- package/dist/apis/CategoriesApi.d.ts +17 -2
- package/dist/apis/CategoriesApi.js +43 -1
- package/dist/apis/CustomTransactionsApi.d.ts +1 -1
- package/dist/apis/MonthsApi.d.ts +1 -1
- package/dist/apis/MonthsApi.js +1 -1
- package/dist/apis/PayeeLocationsApi.d.ts +1 -1
- package/dist/apis/PayeeLocationsApi.js +1 -1
- package/dist/apis/PayeesApi.d.ts +17 -2
- package/dist/apis/PayeesApi.js +43 -1
- package/dist/apis/ScheduledTransactionsApi.d.ts +1 -1
- package/dist/apis/ScheduledTransactionsApi.js +1 -1
- package/dist/apis/TransactionsApi.d.ts +13 -13
- package/dist/apis/TransactionsApi.js +9 -9
- package/dist/apis/UserApi.d.ts +1 -1
- package/dist/apis/UserApi.js +1 -1
- package/dist/apis/index.d.ts +0 -1
- package/dist/apis/index.js +5 -2
- package/dist/browser/ynab.js +1 -1
- package/dist/esm/apis/CategoriesApi.d.ts +16 -1
- package/dist/esm/apis/CategoriesApi.js +65 -1
- package/dist/esm/apis/CustomTransactionsApi.d.ts +1 -1
- package/dist/esm/apis/index.d.ts +0 -1
- package/dist/esm/apis/index.js +0 -1
- package/dist/esm/models/Category.d.ts +0 -1
- package/dist/esm/models/Category.js +0 -1
- package/dist/esm/models/CategoryGoalType.d.ts +25 -0
- package/dist/esm/models/CategoryGoalType.js +29 -0
- package/dist/esm/models/HybridTransaction.d.ts +9 -30
- package/dist/esm/models/HybridTransaction.js +7 -26
- package/dist/esm/models/PatchCategoryWrapper.d.ts +32 -0
- package/dist/esm/models/PatchCategoryWrapper.js +44 -0
- package/dist/esm/models/SaveCategory.d.ts +43 -0
- package/dist/esm/models/SaveCategory.js +47 -0
- package/dist/esm/models/SaveTransaction.d.ts +8 -28
- package/dist/esm/models/SaveTransaction.js +6 -24
- package/dist/esm/models/SaveTransactionWithId.d.ts +8 -28
- package/dist/esm/models/SaveTransactionWithId.js +6 -24
- package/dist/esm/models/SaveTransactionWithOptionalFields.d.ts +8 -28
- package/dist/esm/models/SaveTransactionWithOptionalFields.js +6 -24
- package/dist/esm/models/SaveTransactionWithOptionalFieldsFlagColor.d.ts +25 -0
- package/dist/esm/models/SaveTransactionWithOptionalFieldsFlagColor.js +29 -0
- package/dist/esm/models/ScheduledTransactionDetail.d.ts +4 -16
- package/dist/esm/models/ScheduledTransactionDetail.js +3 -14
- package/dist/esm/models/ScheduledTransactionSummary.d.ts +4 -16
- package/dist/esm/models/ScheduledTransactionSummary.js +3 -14
- package/dist/esm/models/ScheduledTransactionSummaryFlagColor.d.ts +25 -0
- package/dist/esm/models/ScheduledTransactionSummaryFlagColor.js +29 -0
- package/dist/esm/models/TransactionClearedStatus.d.ts +24 -0
- package/dist/esm/models/TransactionClearedStatus.js +31 -0
- package/dist/esm/models/TransactionDetail.d.ts +9 -30
- package/dist/esm/models/TransactionDetail.js +7 -26
- package/dist/esm/models/TransactionFlagColor.d.ts +27 -0
- package/dist/esm/models/TransactionFlagColor.js +34 -0
- package/dist/esm/models/TransactionSummary.d.ts +9 -30
- package/dist/esm/models/TransactionSummary.js +7 -26
- package/dist/esm/models/TransactionSummaryDebtTransactionType.d.ts +25 -0
- package/dist/esm/models/TransactionSummaryDebtTransactionType.js +29 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/index.js +5 -1
- package/dist/models/Account.d.ts +8 -8
- package/dist/models/Account.js +51 -46
- package/dist/models/AccountResponse.d.ts +2 -2
- package/dist/models/AccountResponse.js +8 -11
- package/dist/models/AccountResponseData.d.ts +2 -2
- package/dist/models/AccountResponseData.js +8 -11
- package/dist/models/AccountType.d.ts +3 -2
- package/dist/models/AccountType.js +13 -2
- package/dist/models/AccountsResponse.d.ts +2 -2
- package/dist/models/AccountsResponse.js +8 -11
- package/dist/models/AccountsResponseData.d.ts +2 -2
- package/dist/models/AccountsResponseData.js +11 -13
- package/dist/models/BudgetDetail.d.ts +8 -8
- package/dist/models/BudgetDetail.js +45 -48
- package/dist/models/BudgetDetailResponse.d.ts +2 -2
- package/dist/models/BudgetDetailResponse.js +8 -11
- package/dist/models/BudgetDetailResponseData.d.ts +2 -2
- package/dist/models/BudgetDetailResponseData.js +11 -13
- package/dist/models/BudgetSettings.d.ts +2 -2
- package/dist/models/BudgetSettings.js +11 -13
- package/dist/models/BudgetSettingsResponse.d.ts +2 -2
- package/dist/models/BudgetSettingsResponse.js +8 -11
- package/dist/models/BudgetSettingsResponseData.d.ts +2 -2
- package/dist/models/BudgetSettingsResponseData.js +8 -11
- package/dist/models/BudgetSummary.d.ts +4 -4
- package/dist/models/BudgetSummary.js +23 -26
- package/dist/models/BudgetSummaryResponse.d.ts +2 -2
- package/dist/models/BudgetSummaryResponse.js +8 -11
- package/dist/models/BudgetSummaryResponseData.d.ts +2 -2
- package/dist/models/BudgetSummaryResponseData.js +10 -14
- package/dist/models/BulkResponse.d.ts +2 -2
- package/dist/models/BulkResponse.js +8 -11
- package/dist/models/BulkResponseData.d.ts +2 -2
- package/dist/models/BulkResponseData.js +8 -11
- package/dist/models/BulkResponseDataBulk.d.ts +2 -2
- package/dist/models/BulkResponseDataBulk.js +11 -13
- package/dist/models/BulkTransactions.d.ts +5 -5
- package/dist/models/BulkTransactions.js +10 -13
- package/dist/models/CategoriesResponse.d.ts +2 -2
- package/dist/models/CategoriesResponse.js +8 -11
- package/dist/models/CategoriesResponseData.d.ts +2 -2
- package/dist/models/CategoriesResponseData.js +11 -13
- package/dist/models/Category.d.ts +22 -17
- package/dist/models/Category.js +61 -57
- package/dist/models/CategoryGoalType.d.ts +25 -0
- package/dist/models/CategoryGoalType.js +36 -0
- package/dist/models/CategoryGroup.d.ts +2 -2
- package/dist/models/CategoryGroup.js +17 -17
- package/dist/models/CategoryGroupWithCategories.d.ts +2 -2
- package/dist/models/CategoryGroupWithCategories.js +20 -19
- package/dist/models/CategoryResponse.d.ts +2 -2
- package/dist/models/CategoryResponse.js +8 -11
- package/dist/models/CategoryResponseData.d.ts +2 -2
- package/dist/models/CategoryResponseData.js +8 -11
- package/dist/models/CurrencyFormat.d.ts +2 -2
- package/dist/models/CurrencyFormat.js +29 -25
- package/dist/models/DateFormat.d.ts +2 -2
- package/dist/models/DateFormat.js +8 -11
- package/dist/models/ErrorDetail.d.ts +2 -2
- package/dist/models/ErrorDetail.js +14 -15
- package/dist/models/ErrorResponse.d.ts +2 -2
- package/dist/models/ErrorResponse.js +8 -11
- package/dist/models/ExistingTransaction.d.ts +94 -0
- package/dist/models/ExistingTransaction.js +68 -0
- package/dist/models/HybridTransaction.d.ts +29 -44
- package/dist/models/HybridTransaction.js +67 -80
- package/dist/models/HybridTransactionAllOf.d.ts +1 -1
- package/dist/models/HybridTransactionsResponse.d.ts +2 -2
- package/dist/models/HybridTransactionsResponse.js +8 -11
- package/dist/models/HybridTransactionsResponseData.d.ts +2 -2
- package/dist/models/HybridTransactionsResponseData.js +10 -14
- package/dist/models/MonthDetail.d.ts +4 -4
- package/dist/models/MonthDetail.js +30 -28
- package/dist/models/MonthDetailResponse.d.ts +2 -2
- package/dist/models/MonthDetailResponse.js +8 -11
- package/dist/models/MonthDetailResponseData.d.ts +2 -2
- package/dist/models/MonthDetailResponseData.js +8 -11
- package/dist/models/MonthSummariesResponse.d.ts +2 -2
- package/dist/models/MonthSummariesResponse.js +8 -11
- package/dist/models/MonthSummariesResponseData.d.ts +2 -2
- package/dist/models/MonthSummariesResponseData.js +11 -13
- package/dist/models/MonthSummary.d.ts +4 -4
- package/dist/models/MonthSummary.js +27 -26
- package/dist/models/NewTransaction.d.ts +100 -0
- package/dist/models/NewTransaction.js +70 -0
- package/dist/models/PatchCategoryWrapper.d.ts +32 -0
- package/dist/models/PatchCategoryWrapper.js +48 -0
- package/dist/models/PatchMonthCategoryWrapper.d.ts +2 -2
- package/dist/models/PatchMonthCategoryWrapper.js +8 -11
- package/dist/models/PatchPayeeWrapper.d.ts +32 -0
- package/dist/models/PatchPayeeWrapper.js +48 -0
- package/dist/models/PatchTransactionsWrapper.d.ts +5 -5
- package/dist/models/PatchTransactionsWrapper.js +10 -13
- package/dist/models/Payee.d.ts +3 -3
- package/dist/models/Payee.js +16 -18
- package/dist/models/PayeeLocation.d.ts +2 -2
- package/dist/models/PayeeLocation.js +20 -19
- package/dist/models/PayeeLocationResponse.d.ts +2 -2
- package/dist/models/PayeeLocationResponse.js +8 -11
- package/dist/models/PayeeLocationResponseData.d.ts +2 -2
- package/dist/models/PayeeLocationResponseData.js +8 -11
- package/dist/models/PayeeLocationsResponse.d.ts +2 -2
- package/dist/models/PayeeLocationsResponse.js +8 -11
- package/dist/models/PayeeLocationsResponseData.d.ts +2 -2
- package/dist/models/PayeeLocationsResponseData.js +8 -11
- package/dist/models/PayeeResponse.d.ts +2 -2
- package/dist/models/PayeeResponse.js +8 -11
- package/dist/models/PayeeResponseData.d.ts +2 -2
- package/dist/models/PayeeResponseData.js +8 -11
- package/dist/models/PayeesResponse.d.ts +2 -2
- package/dist/models/PayeesResponse.js +8 -11
- package/dist/models/PayeesResponseData.d.ts +2 -2
- package/dist/models/PayeesResponseData.js +11 -13
- package/dist/models/PostAccountWrapper.d.ts +2 -2
- package/dist/models/PostAccountWrapper.js +8 -11
- package/dist/models/PostTransactionsWrapper.d.ts +7 -7
- package/dist/models/PostTransactionsWrapper.js +10 -15
- package/dist/models/PutTransactionWrapper.d.ts +5 -5
- package/dist/models/PutTransactionWrapper.js +10 -13
- package/dist/models/SaveAccount.d.ts +2 -2
- package/dist/models/SaveAccount.js +14 -15
- package/dist/models/SaveCategory.d.ts +43 -0
- package/dist/models/SaveCategory.js +49 -0
- package/dist/models/SaveCategoryResponse.d.ts +2 -2
- package/dist/models/SaveCategoryResponse.js +8 -11
- package/dist/models/SaveCategoryResponseData.d.ts +2 -2
- package/dist/models/SaveCategoryResponseData.js +11 -13
- package/dist/models/SaveMonthCategory.d.ts +2 -2
- package/dist/models/SaveMonthCategory.js +8 -11
- package/dist/models/SavePayee.d.ts +31 -0
- package/dist/models/SavePayee.js +45 -0
- package/dist/models/SavePayeeResponse.d.ts +32 -0
- package/dist/models/SavePayeeResponse.js +48 -0
- package/dist/models/SavePayeeResponseData.d.ts +38 -0
- package/dist/models/SavePayeeResponseData.js +52 -0
- package/dist/models/SaveSubTransaction.d.ts +6 -6
- package/dist/models/SaveSubTransaction.js +16 -20
- package/dist/models/SaveTransaction.d.ts +8 -28
- package/dist/models/SaveTransaction.js +7 -25
- package/dist/models/SaveTransactionWithId.d.ts +8 -28
- package/dist/models/SaveTransactionWithId.js +7 -25
- package/dist/models/SaveTransactionWithIdOrImportId.d.ts +106 -0
- package/dist/models/SaveTransactionWithIdOrImportId.js +72 -0
- package/dist/models/SaveTransactionWithOptionalFields.d.ts +14 -40
- package/dist/models/SaveTransactionWithOptionalFields.js +30 -55
- package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.d.ts +25 -0
- package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.js +36 -0
- package/dist/models/SaveTransactionsResponse.d.ts +2 -2
- package/dist/models/SaveTransactionsResponse.js +8 -11
- package/dist/models/SaveTransactionsResponseData.d.ts +2 -2
- package/dist/models/SaveTransactionsResponseData.js +17 -20
- package/dist/models/ScheduledSubTransaction.d.ts +6 -6
- package/dist/models/ScheduledSubTransaction.js +25 -26
- package/dist/models/ScheduledTransactionDetail.d.ts +18 -24
- package/dist/models/ScheduledTransactionDetail.js +50 -55
- package/dist/models/ScheduledTransactionResponse.d.ts +2 -2
- package/dist/models/ScheduledTransactionResponse.js +8 -11
- package/dist/models/ScheduledTransactionResponseData.d.ts +2 -2
- package/dist/models/ScheduledTransactionResponseData.js +8 -11
- package/dist/models/ScheduledTransactionSummary.d.ts +16 -22
- package/dist/models/ScheduledTransactionSummary.js +40 -47
- package/dist/models/ScheduledTransactionSummaryFlagColor.d.ts +25 -0
- package/dist/models/ScheduledTransactionSummaryFlagColor.js +36 -0
- package/dist/models/ScheduledTransactionsResponse.d.ts +2 -2
- package/dist/models/ScheduledTransactionsResponse.js +8 -11
- package/dist/models/ScheduledTransactionsResponseData.d.ts +2 -2
- package/dist/models/ScheduledTransactionsResponseData.js +11 -13
- package/dist/models/SubTransaction.d.ts +9 -9
- package/dist/models/SubTransaction.js +31 -32
- package/dist/models/TransactionClearedStatus.d.ts +25 -0
- package/dist/models/TransactionClearedStatus.js +48 -0
- package/dist/models/TransactionDetail.d.ts +28 -43
- package/dist/models/TransactionDetail.js +65 -78
- package/dist/models/TransactionFlagColor.d.ts +28 -0
- package/dist/models/TransactionFlagColor.js +51 -0
- package/dist/models/TransactionResponse.d.ts +2 -2
- package/dist/models/TransactionResponse.js +8 -11
- package/dist/models/TransactionResponseData.d.ts +2 -2
- package/dist/models/TransactionResponseData.js +8 -11
- package/dist/models/TransactionSummary.d.ts +26 -41
- package/dist/models/TransactionSummary.js +55 -70
- package/dist/models/TransactionSummaryDebtTransactionType.d.ts +25 -0
- package/dist/models/TransactionSummaryDebtTransactionType.js +36 -0
- package/dist/models/TransactionsImportResponse.d.ts +2 -2
- package/dist/models/TransactionsImportResponse.js +8 -11
- package/dist/models/TransactionsImportResponseData.d.ts +2 -2
- package/dist/models/TransactionsImportResponseData.js +8 -11
- package/dist/models/TransactionsResponse.d.ts +2 -2
- package/dist/models/TransactionsResponse.js +8 -11
- package/dist/models/TransactionsResponseData.d.ts +2 -2
- package/dist/models/TransactionsResponseData.js +11 -13
- package/dist/models/User.d.ts +2 -2
- package/dist/models/User.js +8 -11
- package/dist/models/UserResponse.d.ts +2 -2
- package/dist/models/UserResponse.js +8 -11
- package/dist/models/UserResponseData.d.ts +2 -2
- package/dist/models/UserResponseData.js +8 -11
- package/dist/models/index.d.ts +11 -9
- package/dist/models/index.js +16 -10
- package/dist/runtime.d.ts +10 -10
- package/dist/runtime.js +1 -1
- package/package.json +6 -7
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { SaveSubTransaction } from './SaveSubTransaction';
|
|
13
|
+
import type { TransactionClearedStatus } from './TransactionClearedStatus';
|
|
14
|
+
import type { TransactionFlagColor } from './TransactionFlagColor';
|
|
13
15
|
/**
|
|
14
16
|
*
|
|
15
17
|
* @export
|
|
@@ -59,11 +61,11 @@ export interface SaveTransaction {
|
|
|
59
61
|
*/
|
|
60
62
|
memo?: string | null;
|
|
61
63
|
/**
|
|
62
|
-
*
|
|
63
|
-
* @type {
|
|
64
|
+
*
|
|
65
|
+
* @type {TransactionClearedStatus}
|
|
64
66
|
* @memberof SaveTransaction
|
|
65
67
|
*/
|
|
66
|
-
cleared?:
|
|
68
|
+
cleared?: TransactionClearedStatus;
|
|
67
69
|
/**
|
|
68
70
|
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
69
71
|
* @type {boolean}
|
|
@@ -71,11 +73,11 @@ export interface SaveTransaction {
|
|
|
71
73
|
*/
|
|
72
74
|
approved?: boolean;
|
|
73
75
|
/**
|
|
74
|
-
*
|
|
75
|
-
* @type {
|
|
76
|
+
*
|
|
77
|
+
* @type {TransactionFlagColor}
|
|
76
78
|
* @memberof SaveTransaction
|
|
77
79
|
*/
|
|
78
|
-
flag_color?:
|
|
80
|
+
flag_color?: TransactionFlagColor | null;
|
|
79
81
|
/**
|
|
80
82
|
* 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).
|
|
81
83
|
* @type {string}
|
|
@@ -89,28 +91,6 @@ export interface SaveTransaction {
|
|
|
89
91
|
*/
|
|
90
92
|
subtransactions?: Array<SaveSubTransaction>;
|
|
91
93
|
}
|
|
92
|
-
/**
|
|
93
|
-
* @export
|
|
94
|
-
*/
|
|
95
|
-
export declare const SaveTransactionClearedEnum: {
|
|
96
|
-
readonly Cleared: "cleared";
|
|
97
|
-
readonly Uncleared: "uncleared";
|
|
98
|
-
readonly Reconciled: "reconciled";
|
|
99
|
-
};
|
|
100
|
-
export declare type SaveTransactionClearedEnum = typeof SaveTransactionClearedEnum[keyof typeof SaveTransactionClearedEnum];
|
|
101
|
-
/**
|
|
102
|
-
* @export
|
|
103
|
-
*/
|
|
104
|
-
export declare const SaveTransactionFlagColorEnum: {
|
|
105
|
-
readonly Red: "red";
|
|
106
|
-
readonly Orange: "orange";
|
|
107
|
-
readonly Yellow: "yellow";
|
|
108
|
-
readonly Green: "green";
|
|
109
|
-
readonly Blue: "blue";
|
|
110
|
-
readonly Purple: "purple";
|
|
111
|
-
readonly Null: "null";
|
|
112
|
-
};
|
|
113
|
-
export declare type SaveTransactionFlagColorEnum = typeof SaveTransactionFlagColorEnum[keyof typeof SaveTransactionFlagColorEnum];
|
|
114
94
|
/**
|
|
115
95
|
* Check if a given object implements the SaveTransaction interface.
|
|
116
96
|
*/
|
|
@@ -13,29 +13,11 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.SaveTransactionToJSON = exports.SaveTransactionFromJSONTyped = exports.SaveTransactionFromJSON = exports.instanceOfSaveTransaction =
|
|
16
|
+
exports.SaveTransactionToJSON = exports.SaveTransactionFromJSONTyped = exports.SaveTransactionFromJSON = exports.instanceOfSaveTransaction = void 0;
|
|
17
17
|
const runtime_1 = require("../runtime");
|
|
18
18
|
const SaveSubTransaction_1 = require("./SaveSubTransaction");
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
*/
|
|
22
|
-
exports.SaveTransactionClearedEnum = {
|
|
23
|
-
Cleared: 'cleared',
|
|
24
|
-
Uncleared: 'uncleared',
|
|
25
|
-
Reconciled: 'reconciled'
|
|
26
|
-
};
|
|
27
|
-
/**
|
|
28
|
-
* @export
|
|
29
|
-
*/
|
|
30
|
-
exports.SaveTransactionFlagColorEnum = {
|
|
31
|
-
Red: 'red',
|
|
32
|
-
Orange: 'orange',
|
|
33
|
-
Yellow: 'yellow',
|
|
34
|
-
Green: 'green',
|
|
35
|
-
Blue: 'blue',
|
|
36
|
-
Purple: 'purple',
|
|
37
|
-
Null: 'null'
|
|
38
|
-
};
|
|
19
|
+
const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
|
|
20
|
+
const TransactionFlagColor_1 = require("./TransactionFlagColor");
|
|
39
21
|
/**
|
|
40
22
|
* Check if a given object implements the SaveTransaction interface.
|
|
41
23
|
*/
|
|
@@ -60,9 +42,9 @@ function SaveTransactionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
42
|
'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
|
|
61
43
|
'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
|
|
62
44
|
'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
|
|
63
|
-
'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
|
|
45
|
+
'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
|
|
64
46
|
'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
|
|
65
|
-
'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
|
|
47
|
+
'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
|
|
66
48
|
'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
|
|
67
49
|
'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
|
|
68
50
|
};
|
|
@@ -83,9 +65,9 @@ function SaveTransactionToJSON(value) {
|
|
|
83
65
|
'payee_name': value.payee_name,
|
|
84
66
|
'category_id': value.category_id,
|
|
85
67
|
'memo': value.memo,
|
|
86
|
-
'cleared': value.cleared,
|
|
68
|
+
'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value.cleared),
|
|
87
69
|
'approved': value.approved,
|
|
88
|
-
'flag_color': value.flag_color,
|
|
70
|
+
'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value.flag_color),
|
|
89
71
|
'import_id': value.import_id,
|
|
90
72
|
'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
|
|
91
73
|
};
|
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { SaveSubTransaction } from './SaveSubTransaction';
|
|
13
|
+
import type { TransactionClearedStatus } from './TransactionClearedStatus';
|
|
14
|
+
import type { TransactionFlagColor } from './TransactionFlagColor';
|
|
13
15
|
/**
|
|
14
16
|
*
|
|
15
17
|
* @export
|
|
@@ -65,11 +67,11 @@ export interface SaveTransactionWithId {
|
|
|
65
67
|
*/
|
|
66
68
|
memo?: string | null;
|
|
67
69
|
/**
|
|
68
|
-
*
|
|
69
|
-
* @type {
|
|
70
|
+
*
|
|
71
|
+
* @type {TransactionClearedStatus}
|
|
70
72
|
* @memberof SaveTransactionWithId
|
|
71
73
|
*/
|
|
72
|
-
cleared?:
|
|
74
|
+
cleared?: TransactionClearedStatus;
|
|
73
75
|
/**
|
|
74
76
|
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
75
77
|
* @type {boolean}
|
|
@@ -77,11 +79,11 @@ export interface SaveTransactionWithId {
|
|
|
77
79
|
*/
|
|
78
80
|
approved?: boolean;
|
|
79
81
|
/**
|
|
80
|
-
*
|
|
81
|
-
* @type {
|
|
82
|
+
*
|
|
83
|
+
* @type {TransactionFlagColor}
|
|
82
84
|
* @memberof SaveTransactionWithId
|
|
83
85
|
*/
|
|
84
|
-
flag_color?:
|
|
86
|
+
flag_color?: TransactionFlagColor | null;
|
|
85
87
|
/**
|
|
86
88
|
* 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).
|
|
87
89
|
* @type {string}
|
|
@@ -95,28 +97,6 @@ export interface SaveTransactionWithId {
|
|
|
95
97
|
*/
|
|
96
98
|
subtransactions?: Array<SaveSubTransaction>;
|
|
97
99
|
}
|
|
98
|
-
/**
|
|
99
|
-
* @export
|
|
100
|
-
*/
|
|
101
|
-
export declare const SaveTransactionWithIdClearedEnum: {
|
|
102
|
-
readonly Cleared: "cleared";
|
|
103
|
-
readonly Uncleared: "uncleared";
|
|
104
|
-
readonly Reconciled: "reconciled";
|
|
105
|
-
};
|
|
106
|
-
export declare type SaveTransactionWithIdClearedEnum = typeof SaveTransactionWithIdClearedEnum[keyof typeof SaveTransactionWithIdClearedEnum];
|
|
107
|
-
/**
|
|
108
|
-
* @export
|
|
109
|
-
*/
|
|
110
|
-
export declare const SaveTransactionWithIdFlagColorEnum: {
|
|
111
|
-
readonly Red: "red";
|
|
112
|
-
readonly Orange: "orange";
|
|
113
|
-
readonly Yellow: "yellow";
|
|
114
|
-
readonly Green: "green";
|
|
115
|
-
readonly Blue: "blue";
|
|
116
|
-
readonly Purple: "purple";
|
|
117
|
-
readonly Null: "null";
|
|
118
|
-
};
|
|
119
|
-
export declare type SaveTransactionWithIdFlagColorEnum = typeof SaveTransactionWithIdFlagColorEnum[keyof typeof SaveTransactionWithIdFlagColorEnum];
|
|
120
100
|
/**
|
|
121
101
|
* Check if a given object implements the SaveTransactionWithId interface.
|
|
122
102
|
*/
|
|
@@ -13,29 +13,11 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.SaveTransactionWithIdToJSON = exports.SaveTransactionWithIdFromJSONTyped = exports.SaveTransactionWithIdFromJSON = exports.instanceOfSaveTransactionWithId =
|
|
16
|
+
exports.SaveTransactionWithIdToJSON = exports.SaveTransactionWithIdFromJSONTyped = exports.SaveTransactionWithIdFromJSON = exports.instanceOfSaveTransactionWithId = void 0;
|
|
17
17
|
const runtime_1 = require("../runtime");
|
|
18
18
|
const SaveSubTransaction_1 = require("./SaveSubTransaction");
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
*/
|
|
22
|
-
exports.SaveTransactionWithIdClearedEnum = {
|
|
23
|
-
Cleared: 'cleared',
|
|
24
|
-
Uncleared: 'uncleared',
|
|
25
|
-
Reconciled: 'reconciled'
|
|
26
|
-
};
|
|
27
|
-
/**
|
|
28
|
-
* @export
|
|
29
|
-
*/
|
|
30
|
-
exports.SaveTransactionWithIdFlagColorEnum = {
|
|
31
|
-
Red: 'red',
|
|
32
|
-
Orange: 'orange',
|
|
33
|
-
Yellow: 'yellow',
|
|
34
|
-
Green: 'green',
|
|
35
|
-
Blue: 'blue',
|
|
36
|
-
Purple: 'purple',
|
|
37
|
-
Null: 'null'
|
|
38
|
-
};
|
|
19
|
+
const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
|
|
20
|
+
const TransactionFlagColor_1 = require("./TransactionFlagColor");
|
|
39
21
|
/**
|
|
40
22
|
* Check if a given object implements the SaveTransactionWithId interface.
|
|
41
23
|
*/
|
|
@@ -61,9 +43,9 @@ function SaveTransactionWithIdFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
61
43
|
'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
|
|
62
44
|
'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
|
|
63
45
|
'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
|
|
64
|
-
'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
|
|
46
|
+
'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
|
|
65
47
|
'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
|
|
66
|
-
'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
|
|
48
|
+
'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
|
|
67
49
|
'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
|
|
68
50
|
'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
|
|
69
51
|
};
|
|
@@ -85,9 +67,9 @@ function SaveTransactionWithIdToJSON(value) {
|
|
|
85
67
|
'payee_name': value.payee_name,
|
|
86
68
|
'category_id': value.category_id,
|
|
87
69
|
'memo': value.memo,
|
|
88
|
-
'cleared': value.cleared,
|
|
70
|
+
'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value.cleared),
|
|
89
71
|
'approved': value.approved,
|
|
90
|
-
'flag_color': value.flag_color,
|
|
72
|
+
'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value.flag_color),
|
|
91
73
|
'import_id': value.import_id,
|
|
92
74
|
'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
|
|
93
75
|
};
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* YNAB API Endpoints
|
|
3
|
+
* Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.ynab.com
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.70.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { TransactionFlagColor } from './TransactionFlagColor';
|
|
13
|
+
import type { TransactionClearedStatus } from './TransactionClearedStatus';
|
|
14
|
+
import type { SaveSubTransaction } from './SaveSubTransaction';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface SaveTransactionWithIdOrImportId
|
|
19
|
+
*/
|
|
20
|
+
export interface SaveTransactionWithIdOrImportId {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
25
|
+
*/
|
|
26
|
+
account_id?: string;
|
|
27
|
+
/**
|
|
28
|
+
* 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.
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
31
|
+
*/
|
|
32
|
+
date?: string;
|
|
33
|
+
/**
|
|
34
|
+
* The transaction amount in milliunits format. Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
|
|
35
|
+
* @type {number}
|
|
36
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
37
|
+
*/
|
|
38
|
+
amount?: number;
|
|
39
|
+
/**
|
|
40
|
+
* 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.
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
43
|
+
*/
|
|
44
|
+
payee_id?: string;
|
|
45
|
+
/**
|
|
46
|
+
* 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.
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
49
|
+
*/
|
|
50
|
+
payee_name?: string;
|
|
51
|
+
/**
|
|
52
|
+
* 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.
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
55
|
+
*/
|
|
56
|
+
category_id?: string;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
61
|
+
*/
|
|
62
|
+
memo?: string;
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @type {TransactionClearedStatus}
|
|
66
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
67
|
+
*/
|
|
68
|
+
cleared?: TransactionClearedStatus;
|
|
69
|
+
/**
|
|
70
|
+
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
71
|
+
* @type {boolean}
|
|
72
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
73
|
+
*/
|
|
74
|
+
approved?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
* @type {TransactionFlagColor}
|
|
78
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
79
|
+
*/
|
|
80
|
+
flag_color?: TransactionFlagColor;
|
|
81
|
+
/**
|
|
82
|
+
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
83
|
+
* @type {Array<SaveSubTransaction>}
|
|
84
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
85
|
+
*/
|
|
86
|
+
subtransactions?: Array<SaveSubTransaction>;
|
|
87
|
+
/**
|
|
88
|
+
* If specified, this id will be used to lookup a transaction by its `id` for the purpose of updating the transaction itself. If not specified, an `import_id` should be supplied.
|
|
89
|
+
* @type {string}
|
|
90
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
91
|
+
*/
|
|
92
|
+
id?: string;
|
|
93
|
+
/**
|
|
94
|
+
* If specified, this id will be used to lookup a transaction by its `import_id` for the purpose of updating the transaction itself. If not specified, an `id` should be supplied. You may not provide both an `id` and an `import_id` and updating an `import_id` on an existing transaction is not allowed.
|
|
95
|
+
* @type {string}
|
|
96
|
+
* @memberof SaveTransactionWithIdOrImportId
|
|
97
|
+
*/
|
|
98
|
+
import_id?: string;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Check if a given object implements the SaveTransactionWithIdOrImportId interface.
|
|
102
|
+
*/
|
|
103
|
+
export declare function instanceOfSaveTransactionWithIdOrImportId(value: object): value is SaveTransactionWithIdOrImportId;
|
|
104
|
+
export declare function SaveTransactionWithIdOrImportIdFromJSON(json: any): SaveTransactionWithIdOrImportId;
|
|
105
|
+
export declare function SaveTransactionWithIdOrImportIdFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransactionWithIdOrImportId;
|
|
106
|
+
export declare function SaveTransactionWithIdOrImportIdToJSON(value?: SaveTransactionWithIdOrImportId | null): any;
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* YNAB API Endpoints
|
|
6
|
+
* Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.ynab.com
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.70.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SaveTransactionWithIdOrImportIdToJSON = exports.SaveTransactionWithIdOrImportIdFromJSONTyped = exports.SaveTransactionWithIdOrImportIdFromJSON = exports.instanceOfSaveTransactionWithIdOrImportId = void 0;
|
|
17
|
+
const TransactionFlagColor_1 = require("./TransactionFlagColor");
|
|
18
|
+
const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
|
|
19
|
+
const SaveSubTransaction_1 = require("./SaveSubTransaction");
|
|
20
|
+
/**
|
|
21
|
+
* Check if a given object implements the SaveTransactionWithIdOrImportId interface.
|
|
22
|
+
*/
|
|
23
|
+
function instanceOfSaveTransactionWithIdOrImportId(value) {
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
exports.instanceOfSaveTransactionWithIdOrImportId = instanceOfSaveTransactionWithIdOrImportId;
|
|
27
|
+
function SaveTransactionWithIdOrImportIdFromJSON(json) {
|
|
28
|
+
return SaveTransactionWithIdOrImportIdFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
exports.SaveTransactionWithIdOrImportIdFromJSON = SaveTransactionWithIdOrImportIdFromJSON;
|
|
31
|
+
function SaveTransactionWithIdOrImportIdFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if (json == null) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'account_id': json['account_id'] == null ? undefined : json['account_id'],
|
|
37
|
+
'date': json['date'] == null ? undefined : json['date'],
|
|
38
|
+
'amount': json['amount'] == null ? undefined : json['amount'],
|
|
39
|
+
'payee_id': json['payee_id'] == null ? undefined : json['payee_id'],
|
|
40
|
+
'payee_name': json['payee_name'] == null ? undefined : json['payee_name'],
|
|
41
|
+
'category_id': json['category_id'] == null ? undefined : json['category_id'],
|
|
42
|
+
'memo': json['memo'] == null ? undefined : json['memo'],
|
|
43
|
+
'cleared': json['cleared'] == null ? undefined : (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
|
|
44
|
+
'approved': json['approved'] == null ? undefined : json['approved'],
|
|
45
|
+
'flag_color': json['flag_color'] == null ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
|
|
46
|
+
'subtransactions': json['subtransactions'] == null ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
|
|
47
|
+
'id': json['id'] == null ? undefined : json['id'],
|
|
48
|
+
'import_id': json['import_id'] == null ? undefined : json['import_id'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
exports.SaveTransactionWithIdOrImportIdFromJSONTyped = SaveTransactionWithIdOrImportIdFromJSONTyped;
|
|
52
|
+
function SaveTransactionWithIdOrImportIdToJSON(value) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'account_id': value['account_id'],
|
|
58
|
+
'date': value['date'],
|
|
59
|
+
'amount': value['amount'],
|
|
60
|
+
'payee_id': value['payee_id'],
|
|
61
|
+
'payee_name': value['payee_name'],
|
|
62
|
+
'category_id': value['category_id'],
|
|
63
|
+
'memo': value['memo'],
|
|
64
|
+
'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value['cleared']),
|
|
65
|
+
'approved': value['approved'],
|
|
66
|
+
'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value['flag_color']),
|
|
67
|
+
'subtransactions': value['subtransactions'] == null ? undefined : (value['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
|
|
68
|
+
'id': value['id'],
|
|
69
|
+
'import_id': value['import_id'],
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
exports.SaveTransactionWithIdOrImportIdToJSON = SaveTransactionWithIdOrImportIdToJSON;
|
|
@@ -2,13 +2,15 @@
|
|
|
2
2
|
* YNAB API Endpoints
|
|
3
3
|
* Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.ynab.com
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.70.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { TransactionFlagColor } from './TransactionFlagColor';
|
|
13
|
+
import type { TransactionClearedStatus } from './TransactionClearedStatus';
|
|
12
14
|
import type { SaveSubTransaction } from './SaveSubTransaction';
|
|
13
15
|
/**
|
|
14
16
|
*
|
|
@@ -39,31 +41,31 @@ export interface SaveTransactionWithOptionalFields {
|
|
|
39
41
|
* @type {string}
|
|
40
42
|
* @memberof SaveTransactionWithOptionalFields
|
|
41
43
|
*/
|
|
42
|
-
payee_id?: string
|
|
44
|
+
payee_id?: string;
|
|
43
45
|
/**
|
|
44
46
|
* 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.
|
|
45
47
|
* @type {string}
|
|
46
48
|
* @memberof SaveTransactionWithOptionalFields
|
|
47
49
|
*/
|
|
48
|
-
payee_name?: string
|
|
50
|
+
payee_name?: string;
|
|
49
51
|
/**
|
|
50
52
|
* 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.
|
|
51
53
|
* @type {string}
|
|
52
54
|
* @memberof SaveTransactionWithOptionalFields
|
|
53
55
|
*/
|
|
54
|
-
category_id?: string
|
|
56
|
+
category_id?: string;
|
|
55
57
|
/**
|
|
56
58
|
*
|
|
57
59
|
* @type {string}
|
|
58
60
|
* @memberof SaveTransactionWithOptionalFields
|
|
59
61
|
*/
|
|
60
|
-
memo?: string
|
|
62
|
+
memo?: string;
|
|
61
63
|
/**
|
|
62
|
-
*
|
|
63
|
-
* @type {
|
|
64
|
+
*
|
|
65
|
+
* @type {TransactionClearedStatus}
|
|
64
66
|
* @memberof SaveTransactionWithOptionalFields
|
|
65
67
|
*/
|
|
66
|
-
cleared?:
|
|
68
|
+
cleared?: TransactionClearedStatus;
|
|
67
69
|
/**
|
|
68
70
|
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
|
|
69
71
|
* @type {boolean}
|
|
@@ -71,17 +73,11 @@ export interface SaveTransactionWithOptionalFields {
|
|
|
71
73
|
*/
|
|
72
74
|
approved?: boolean;
|
|
73
75
|
/**
|
|
74
|
-
*
|
|
75
|
-
* @type {
|
|
76
|
-
* @memberof SaveTransactionWithOptionalFields
|
|
77
|
-
*/
|
|
78
|
-
flag_color?: SaveTransactionWithOptionalFieldsFlagColorEnum;
|
|
79
|
-
/**
|
|
80
|
-
* 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).
|
|
81
|
-
* @type {string}
|
|
76
|
+
*
|
|
77
|
+
* @type {TransactionFlagColor}
|
|
82
78
|
* @memberof SaveTransactionWithOptionalFields
|
|
83
79
|
*/
|
|
84
|
-
|
|
80
|
+
flag_color?: TransactionFlagColor;
|
|
85
81
|
/**
|
|
86
82
|
* An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
|
|
87
83
|
* @type {Array<SaveSubTransaction>}
|
|
@@ -89,32 +85,10 @@ export interface SaveTransactionWithOptionalFields {
|
|
|
89
85
|
*/
|
|
90
86
|
subtransactions?: Array<SaveSubTransaction>;
|
|
91
87
|
}
|
|
92
|
-
/**
|
|
93
|
-
* @export
|
|
94
|
-
*/
|
|
95
|
-
export declare const SaveTransactionWithOptionalFieldsClearedEnum: {
|
|
96
|
-
readonly Cleared: "cleared";
|
|
97
|
-
readonly Uncleared: "uncleared";
|
|
98
|
-
readonly Reconciled: "reconciled";
|
|
99
|
-
};
|
|
100
|
-
export declare type SaveTransactionWithOptionalFieldsClearedEnum = typeof SaveTransactionWithOptionalFieldsClearedEnum[keyof typeof SaveTransactionWithOptionalFieldsClearedEnum];
|
|
101
|
-
/**
|
|
102
|
-
* @export
|
|
103
|
-
*/
|
|
104
|
-
export declare const SaveTransactionWithOptionalFieldsFlagColorEnum: {
|
|
105
|
-
readonly Red: "red";
|
|
106
|
-
readonly Orange: "orange";
|
|
107
|
-
readonly Yellow: "yellow";
|
|
108
|
-
readonly Green: "green";
|
|
109
|
-
readonly Blue: "blue";
|
|
110
|
-
readonly Purple: "purple";
|
|
111
|
-
readonly Null: "null";
|
|
112
|
-
};
|
|
113
|
-
export declare type SaveTransactionWithOptionalFieldsFlagColorEnum = typeof SaveTransactionWithOptionalFieldsFlagColorEnum[keyof typeof SaveTransactionWithOptionalFieldsFlagColorEnum];
|
|
114
88
|
/**
|
|
115
89
|
* Check if a given object implements the SaveTransactionWithOptionalFields interface.
|
|
116
90
|
*/
|
|
117
|
-
export declare function instanceOfSaveTransactionWithOptionalFields(value: object):
|
|
91
|
+
export declare function instanceOfSaveTransactionWithOptionalFields(value: object): value is SaveTransactionWithOptionalFields;
|
|
118
92
|
export declare function SaveTransactionWithOptionalFieldsFromJSON(json: any): SaveTransactionWithOptionalFields;
|
|
119
93
|
export declare function SaveTransactionWithOptionalFieldsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransactionWithOptionalFields;
|
|
120
94
|
export declare function SaveTransactionWithOptionalFieldsToJSON(value?: SaveTransactionWithOptionalFields | null): any;
|