ynab 1.55.0 → 2.0.0-rc.1

package/dist/models/SaveTransaction.d.ts

@@ -0,0 +1,120 @@
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SaveSubTransaction } from './SaveSubTransaction';
+/**
+ *
+ * @export
+ * @interface SaveTransaction
+ */
+export interface SaveTransaction {
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    account_id?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    date?: string;
+    /**
+     * The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
+     * @type {number}
+     * @memberof SaveTransaction
+     */
+    amount?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    payee_id?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    payee_name?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    memo?: string | null;
+    /**
+     * The cleared status of the transaction
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    cleared?: SaveTransactionClearedEnum;
+    /**
+     * Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default.
+     * @type {boolean}
+     * @memberof SaveTransaction
+     */
+    approved?: boolean;
+    /**
+     * The transaction flag
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    flag_color?: SaveTransactionFlagColorEnum;
+    /**
+     * 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).
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    import_id?: string | null;
+    /**
+     * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
+     * @type {Array<SaveSubTransaction>}
+     * @memberof SaveTransaction
+     */
+    subtransactions?: Array<SaveSubTransaction>;
+}
+/**
+ * @export
+ */
+export declare const SaveTransactionClearedEnum: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export declare type SaveTransactionClearedEnum = typeof SaveTransactionClearedEnum[keyof typeof SaveTransactionClearedEnum];
+/**
+ * @export
+ */
+export declare const SaveTransactionFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type SaveTransactionFlagColorEnum = typeof SaveTransactionFlagColorEnum[keyof typeof SaveTransactionFlagColorEnum];
+/**
+ * Check if a given object implements the SaveTransaction interface.
+ */
+export declare function instanceOfSaveTransaction(value: object): boolean;
+export declare function SaveTransactionFromJSON(json: any): SaveTransaction;
+export declare function SaveTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransaction;
+export declare function SaveTransactionToJSON(value?: SaveTransaction | null): any;

package/dist/models/SaveTransaction.js

@@ -0,0 +1,93 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaveTransactionToJSON = exports.SaveTransactionFromJSONTyped = exports.SaveTransactionFromJSON = exports.instanceOfSaveTransaction = exports.SaveTransactionFlagColorEnum = exports.SaveTransactionClearedEnum = void 0;
+const runtime_1 = require("../runtime");
+const SaveSubTransaction_1 = require("./SaveSubTransaction");
+/**
+ * @export
+ */
+exports.SaveTransactionClearedEnum = {
+    Cleared: 'cleared',
+    Uncleared: 'uncleared',
+    Reconciled: 'reconciled'
+};
+/**
+ * @export
+ */
+exports.SaveTransactionFlagColorEnum = {
+    Red: 'red',
+    Orange: 'orange',
+    Yellow: 'yellow',
+    Green: 'green',
+    Blue: 'blue',
+    Purple: 'purple',
+    Null: 'null'
+};
+/**
+ * Check if a given object implements the SaveTransaction interface.
+ */
+function instanceOfSaveTransaction(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSaveTransaction = instanceOfSaveTransaction;
+function SaveTransactionFromJSON(json) {
+    return SaveTransactionFromJSONTyped(json, false);
+}
+exports.SaveTransactionFromJSON = SaveTransactionFromJSON;
+function SaveTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'account_id': !(0, runtime_1.exists)(json, 'account_id') ? undefined : json['account_id'],
+        'date': !(0, runtime_1.exists)(json, 'date') ? undefined : json['date'],
+        'amount': !(0, runtime_1.exists)(json, 'amount') ? undefined : json['amount'],
+        'payee_id': !(0, runtime_1.exists)(json, 'payee_id') ? undefined : json['payee_id'],
+        'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
+        'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
+        'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
+        'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
+        'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
+        'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
+        'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
+    };
+}
+exports.SaveTransactionFromJSONTyped = SaveTransactionFromJSONTyped;
+function SaveTransactionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'account_id': value.account_id,
+        'date': value.date,
+        'amount': value.amount,
+        'payee_id': value.payee_id,
+        'payee_name': value.payee_name,
+        'category_id': value.category_id,
+        'memo': value.memo,
+        'cleared': value.cleared,
+        'approved': value.approved,
+        'flag_color': value.flag_color,
+        'import_id': value.import_id,
+        'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
+    };
+}
+exports.SaveTransactionToJSON = SaveTransactionToJSON;

package/dist/models/SaveTransactionWithId.d.ts

@@ -0,0 +1,126 @@
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SaveSubTransaction } from './SaveSubTransaction';
+/**
+ *
+ * @export
+ * @interface SaveTransactionWithId
+ */
+export interface SaveTransactionWithId {
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    account_id?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    date?: string;
+    /**
+     * The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
+     * @type {number}
+     * @memberof SaveTransactionWithId
+     */
+    amount?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    payee_id?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    payee_name?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    memo?: string | null;
+    /**
+     * The cleared status of the transaction
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    cleared?: SaveTransactionWithIdClearedEnum;
+    /**
+     * Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default.
+     * @type {boolean}
+     * @memberof SaveTransactionWithId
+     */
+    approved?: boolean;
+    /**
+     * The transaction flag
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    flag_color?: SaveTransactionWithIdFlagColorEnum;
+    /**
+     * 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).
+     * @type {string}
+     * @memberof SaveTransactionWithId
+     */
+    import_id?: string | null;
+    /**
+     * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
+     * @type {Array<SaveSubTransaction>}
+     * @memberof SaveTransactionWithId
+     */
+    subtransactions?: Array<SaveSubTransaction>;
+}
+/**
+ * @export
+ */
+export declare const SaveTransactionWithIdClearedEnum: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export declare type SaveTransactionWithIdClearedEnum = typeof SaveTransactionWithIdClearedEnum[keyof typeof SaveTransactionWithIdClearedEnum];
+/**
+ * @export
+ */
+export declare const SaveTransactionWithIdFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type SaveTransactionWithIdFlagColorEnum = typeof SaveTransactionWithIdFlagColorEnum[keyof typeof SaveTransactionWithIdFlagColorEnum];
+/**
+ * Check if a given object implements the SaveTransactionWithId interface.
+ */
+export declare function instanceOfSaveTransactionWithId(value: object): boolean;
+export declare function SaveTransactionWithIdFromJSON(json: any): SaveTransactionWithId;
+export declare function SaveTransactionWithIdFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransactionWithId;
+export declare function SaveTransactionWithIdToJSON(value?: SaveTransactionWithId | null): any;

package/dist/models/SaveTransactionWithId.js

@@ -0,0 +1,95 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaveTransactionWithIdToJSON = exports.SaveTransactionWithIdFromJSONTyped = exports.SaveTransactionWithIdFromJSON = exports.instanceOfSaveTransactionWithId = exports.SaveTransactionWithIdFlagColorEnum = exports.SaveTransactionWithIdClearedEnum = void 0;
+const runtime_1 = require("../runtime");
+const SaveSubTransaction_1 = require("./SaveSubTransaction");
+/**
+ * @export
+ */
+exports.SaveTransactionWithIdClearedEnum = {
+    Cleared: 'cleared',
+    Uncleared: 'uncleared',
+    Reconciled: 'reconciled'
+};
+/**
+ * @export
+ */
+exports.SaveTransactionWithIdFlagColorEnum = {
+    Red: 'red',
+    Orange: 'orange',
+    Yellow: 'yellow',
+    Green: 'green',
+    Blue: 'blue',
+    Purple: 'purple',
+    Null: 'null'
+};
+/**
+ * Check if a given object implements the SaveTransactionWithId interface.
+ */
+function instanceOfSaveTransactionWithId(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSaveTransactionWithId = instanceOfSaveTransactionWithId;
+function SaveTransactionWithIdFromJSON(json) {
+    return SaveTransactionWithIdFromJSONTyped(json, false);
+}
+exports.SaveTransactionWithIdFromJSON = SaveTransactionWithIdFromJSON;
+function SaveTransactionWithIdFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': !(0, runtime_1.exists)(json, 'id') ? undefined : json['id'],
+        'account_id': !(0, runtime_1.exists)(json, 'account_id') ? undefined : json['account_id'],
+        'date': !(0, runtime_1.exists)(json, 'date') ? undefined : json['date'],
+        'amount': !(0, runtime_1.exists)(json, 'amount') ? undefined : json['amount'],
+        'payee_id': !(0, runtime_1.exists)(json, 'payee_id') ? undefined : json['payee_id'],
+        'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
+        'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
+        'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
+        'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
+        'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
+        'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
+        'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
+    };
+}
+exports.SaveTransactionWithIdFromJSONTyped = SaveTransactionWithIdFromJSONTyped;
+function SaveTransactionWithIdToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'account_id': value.account_id,
+        'date': value.date,
+        'amount': value.amount,
+        'payee_id': value.payee_id,
+        'payee_name': value.payee_name,
+        'category_id': value.category_id,
+        'memo': value.memo,
+        'cleared': value.cleared,
+        'approved': value.approved,
+        'flag_color': value.flag_color,
+        'import_id': value.import_id,
+        'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
+    };
+}
+exports.SaveTransactionWithIdToJSON = SaveTransactionWithIdToJSON;

package/dist/models/SaveTransactionWithIdAllOf.d.ts

@@ -0,0 +1,31 @@
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SaveTransactionWithIdAllOf
+ */
+export interface SaveTransactionWithIdAllOf {
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransactionWithIdAllOf
+     */
+    id?: string;
+}
+/**
+ * Check if a given object implements the SaveTransactionWithIdAllOf interface.
+ */
+export declare function instanceOfSaveTransactionWithIdAllOf(value: object): boolean;
+export declare function SaveTransactionWithIdAllOfFromJSON(json: any): SaveTransactionWithIdAllOf;
+export declare function SaveTransactionWithIdAllOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransactionWithIdAllOf;
+export declare function SaveTransactionWithIdAllOfToJSON(value?: SaveTransactionWithIdAllOf | null): any;

package/dist/models/SaveTransactionWithIdAllOf.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaveTransactionWithIdAllOfToJSON = exports.SaveTransactionWithIdAllOfFromJSONTyped = exports.SaveTransactionWithIdAllOfFromJSON = exports.instanceOfSaveTransactionWithIdAllOf = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SaveTransactionWithIdAllOf interface.
+ */
+function instanceOfSaveTransactionWithIdAllOf(value) {
+    let isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSaveTransactionWithIdAllOf = instanceOfSaveTransactionWithIdAllOf;
+function SaveTransactionWithIdAllOfFromJSON(json) {
+    return SaveTransactionWithIdAllOfFromJSONTyped(json, false);
+}
+exports.SaveTransactionWithIdAllOfFromJSON = SaveTransactionWithIdAllOfFromJSON;
+function SaveTransactionWithIdAllOfFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': !(0, runtime_1.exists)(json, 'id') ? undefined : json['id'],
+    };
+}
+exports.SaveTransactionWithIdAllOfFromJSONTyped = SaveTransactionWithIdAllOfFromJSONTyped;
+function SaveTransactionWithIdAllOfToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+    };
+}
+exports.SaveTransactionWithIdAllOfToJSON = SaveTransactionWithIdAllOfToJSON;

package/dist/models/SaveTransactionWithOptionalFields.d.ts

@@ -0,0 +1,120 @@
+/**
+ * YNAB API Endpoints
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SaveSubTransaction } from './SaveSubTransaction';
+/**
+ *
+ * @export
+ * @interface SaveTransactionWithOptionalFields
+ */
+export interface SaveTransactionWithOptionalFields {
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    account_id?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    date?: string;
+    /**
+     * The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
+     * @type {number}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    amount?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    payee_id?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    payee_name?: string | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    memo?: string | null;
+    /**
+     * The cleared status of the transaction
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    cleared?: SaveTransactionWithOptionalFieldsClearedEnum;
+    /**
+     * Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default.
+     * @type {boolean}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    approved?: boolean;
+    /**
+     * The transaction flag
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    flag_color?: SaveTransactionWithOptionalFieldsFlagColorEnum;
+    /**
+     * 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).
+     * @type {string}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    import_id?: string | null;
+    /**
+     * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
+     * @type {Array<SaveSubTransaction>}
+     * @memberof SaveTransactionWithOptionalFields
+     */
+    subtransactions?: Array<SaveSubTransaction>;
+}
+/**
+ * @export
+ */
+export declare const SaveTransactionWithOptionalFieldsClearedEnum: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export declare type SaveTransactionWithOptionalFieldsClearedEnum = typeof SaveTransactionWithOptionalFieldsClearedEnum[keyof typeof SaveTransactionWithOptionalFieldsClearedEnum];
+/**
+ * @export
+ */
+export declare const SaveTransactionWithOptionalFieldsFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type SaveTransactionWithOptionalFieldsFlagColorEnum = typeof SaveTransactionWithOptionalFieldsFlagColorEnum[keyof typeof SaveTransactionWithOptionalFieldsFlagColorEnum];
+/**
+ * Check if a given object implements the SaveTransactionWithOptionalFields interface.
+ */
+export declare function instanceOfSaveTransactionWithOptionalFields(value: object): boolean;
+export declare function SaveTransactionWithOptionalFieldsFromJSON(json: any): SaveTransactionWithOptionalFields;
+export declare function SaveTransactionWithOptionalFieldsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransactionWithOptionalFields;
+export declare function SaveTransactionWithOptionalFieldsToJSON(value?: SaveTransactionWithOptionalFields | null): any;