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
78 lines (77 loc) • 3.21 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
*
* Generated by: OpenAPI Generator (https://openapi-generator.tech)
*/
import type { TransactionFlagColor } from './TransactionFlagColor';
import type { ScheduledTransactionFrequency } from './ScheduledTransactionFrequency';
/**
*
* @export
* @interface SaveScheduledTransaction
*/
export interface SaveScheduledTransaction {
/**
*
* @type {string}
* @memberof SaveScheduledTransaction
*/
account_id: string;
/**
* The scheduled transaction date in ISO format (e.g. 2016-12-01). This should be a future date no more than 5 years into the future.
* @type {string}
* @memberof SaveScheduledTransaction
*/
date: string;
/**
* The scheduled transaction amount in milliunits format.
* @type {number}
* @memberof SaveScheduledTransaction
*/
amount?: number;
/**
* The payee for the scheduled transaction. To create a transfer between two accounts, use the account transfer payee pointing to the target account. Account transfer payees are specified as `transfer_payee_id` on the account resource.
* @type {string}
* @memberof SaveScheduledTransaction
*/
payee_id?: string | null;
/**
* The payee name for the the scheduled transaction. 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 payee with the same name or (2) creation of a new payee.
* @type {string}
* @memberof SaveScheduledTransaction
*/
payee_name?: string | null;
/**
* The category for the scheduled transaction. Credit Card Payment categories are not permitted. Creating a split scheduled transaction is not currently supported.
* @type {string}
* @memberof SaveScheduledTransaction
*/
category_id?: string | null;
/**
*
* @type {string}
* @memberof SaveScheduledTransaction
*/
memo?: string | null;
/**
*
* @type {TransactionFlagColor}
* @memberof SaveScheduledTransaction
*/
flag_color?: TransactionFlagColor | null;
/**
*
* @type {ScheduledTransactionFrequency}
* @memberof SaveScheduledTransaction
*/
frequency?: ScheduledTransactionFrequency;
}
/**
* Check if a given object implements the SaveScheduledTransaction interface.
*/
export declare function instanceOfSaveScheduledTransaction(value: object): value is SaveScheduledTransaction;
export declare function SaveScheduledTransactionFromJSON(json: any): SaveScheduledTransaction;
export declare function SaveScheduledTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveScheduledTransaction;
export declare function SaveScheduledTransactionToJSON(json: any): SaveScheduledTransaction;
export declare function SaveScheduledTransactionToJSONTyped(value?: SaveScheduledTransaction | null, ignoreDiscriminator?: boolean): any;