/** * 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 * * Generated by: OpenAPI Generator (https://openapi-generator.tech) */ import type { TransactionFlagColor } from './TransactionFlagColor'; import type { TransactionClearedStatus } from './TransactionClearedStatus'; /** * * @export * @interface TransactionSummaryBase */ export interface TransactionSummaryBase { /** * * @type {string} * @memberof TransactionSummaryBase */ id: string; /** * The transaction date in ISO format (e.g. 2016-12-01) * @type {string} * @memberof TransactionSummaryBase */ date: string; /** * The transaction amount in milliunits format * @type {number} * @memberof TransactionSummaryBase */ amount: number; /** * * @type {string} * @memberof TransactionSummaryBase */ memo?: string | null; /** * * @type {TransactionClearedStatus} * @memberof TransactionSummaryBase */ cleared: TransactionClearedStatus; /** * Whether or not the transaction is approved * @type {boolean} * @memberof TransactionSummaryBase */ approved: boolean; /** * * @type {TransactionFlagColor} * @memberof TransactionSummaryBase */ flag_color?: TransactionFlagColor | null; /** * The customized name of a transaction flag * @type {string} * @memberof TransactionSummaryBase */ flag_name?: string | null; /** * * @type {string} * @memberof TransactionSummaryBase */ account_id: string; /** * * @type {string} * @memberof TransactionSummaryBase */ payee_id?: string | null; /** * * @type {string} * @memberof TransactionSummaryBase */ category_id?: string | null; /** * If a transfer transaction, the account to which it transfers * @type {string} * @memberof TransactionSummaryBase */ transfer_account_id?: string | null; /** * If a transfer transaction, the id of transaction on the other side of the transfer * @type {string} * @memberof TransactionSummaryBase */ transfer_transaction_id?: string | null; /** * If transaction is matched, the id of the matched transaction * @type {string} * @memberof TransactionSummaryBase */ matched_transaction_id?: string | null; /** * 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'. * @type {string} * @memberof TransactionSummaryBase */ import_id?: string | null; /** * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules * @type {string} * @memberof TransactionSummaryBase */ import_payee_name?: string | null; /** * If the transaction was imported, the original payee name as it appeared on the statement * @type {string} * @memberof TransactionSummaryBase */ import_payee_name_original?: string | null; /** * If the transaction is a debt/loan account transaction, the type of transaction * @type {TransactionSummaryBaseDebtTransactionTypeEnum} * @memberof TransactionSummaryBase */ debt_transaction_type?: TransactionSummaryBaseDebtTransactionTypeEnum | null; /** * Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests. * @type {boolean} * @memberof TransactionSummaryBase */ deleted: boolean; } /** * @export */ export declare const TransactionSummaryBaseDebtTransactionTypeEnum: { readonly Payment: "payment"; readonly Refund: "refund"; readonly Fee: "fee"; readonly Interest: "interest"; readonly Escrow: "escrow"; readonly BalanceAdjustment: "balanceAdjustment"; readonly Credit: "credit"; readonly Charge: "charge"; }; export type TransactionSummaryBaseDebtTransactionTypeEnum = typeof TransactionSummaryBaseDebtTransactionTypeEnum[keyof typeof TransactionSummaryBaseDebtTransactionTypeEnum]; /** * Check if a given object implements the TransactionSummaryBase interface. */ export declare function instanceOfTransactionSummaryBase(value: object): value is TransactionSummaryBase; export declare function TransactionSummaryBaseFromJSON(json: any): TransactionSummaryBase; export declare function TransactionSummaryBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionSummaryBase; export declare function TransactionSummaryBaseToJSON(json: any): TransactionSummaryBase; export declare function TransactionSummaryBaseToJSONTyped(value?: TransactionSummaryBase | null, ignoreDiscriminator?: boolean): any;