ynab
Version:
Official JavaScript client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.76.0
101 lines (100 loc) • 5.16 kB
TypeScript
/**
* 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';
import type { TransactionClearedStatus } from './TransactionClearedStatus';
import type { TransactionFlagColor } from './TransactionFlagColor';
/**
*
* @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;
/**
*
* @type {TransactionClearedStatus}
* @memberof SaveTransaction
*/
cleared?: TransactionClearedStatus;
/**
* Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
* @type {boolean}
* @memberof SaveTransaction
*/
approved?: boolean;
/**
*
* @type {TransactionFlagColor}
* @memberof SaveTransaction
*/
flag_color?: TransactionFlagColor | null;
/**
* 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>;
}
/**
* 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;