import { BaseOtherInvestmentTransaction } from "./BaseOtherInvestmentTransaction"; import { TransactionWithSecurity } from "./TransactionWithSecurity"; import { SecurityId } from "../../seclist/SecurityId"; import { OriginalCurrency } from "./OriginalCurrency"; import { IncomeType } from "./IncomeType"; import { SubAccountType } from "../accounts/SubAccountType"; import { Inv401KSource } from "../positions/Inv401KSource"; /** * Transaction for investment income that is realized as cash into the investment account. * @see "Section 13.9.2.4.4, OFX Spec" */ export declare class IncomeTransaction extends BaseOtherInvestmentTransaction implements TransactionWithSecurity { private securityId; private incomeType; private total; private subAccountSecurity; private subAccountFund; private taxExempt; private withholding; private currencyCode; private originalCurrencyInfo; private inv401kSource; constructor(); /** * Gets the id of the security that the income was for. This is a required field according to the * OFX spec. * @see "Section 13.9.2.4.4, OFX Spec" * * @return the security id of the security that the income was for */ getSecurityId(): SecurityId; /** * Sets the id of the security that the income was for. This is a required field according to the * OFX spec. * @see "Section 13.9.2.4.4, OFX Spec" * * @param securityId the security id of the security that the income was for */ setSecurityId(securityId: SecurityId): void; /** * Gets the type of income. One of "CGLONG" (long term capital gains), "CGSHORT" (short term * capital gains), "DIV" (dividend), INTEREST, or MISC> * @see "Section 13.9.2.4.4, OFX Spec" This is a required field according to the OFX spec. * * @return the type of income */ getIncomeType(): string; /** * Sets the type of income. One of "CGLONG" (long term capital gains), "CGSHORT" (short term * capital gains), "DIV" (dividend), INTEREST, or MISC> * @see "Section 13.9.2.4.4, OFX Spec" This is a required field according to the OFX spec. * * @param incomeType the type of income */ setIncomeType(incomeType: string): void; /** * Gets the income type as one of the well-known types. * * @return the income type or null if it's not well known */ getIncomeTypeEnum(): IncomeType; /** * Gets the total income received. * @see "Section 13.9.2.4.4, OFX Spec" * * @return the total */ getTotal(): number; /** * Sets the total income received. * @see "Section 13.9.2.4.4, OFX Spec" * * @param total the total */ setTotal(total: number): void; /** * Gets the sub account type for the security (e.g. CASH, MARGIN, SHORT, OTHER). * @see "Section 13.9.2.4.3, OFX Spec" * * @return the sub account type */ getSubAccountSecurity(): string; /** * Sets the sub account type for the security (e.g. CASH, MARGIN, SHORT, OTHER). * @see "Section 13.9.2.4.3, OFX Spec" * * @param subAcctSec the sub account type */ setSubAccountSecurity(subAcctSec: string): void; /** * Gets the result of getSubAccountSecurity as one of the well-known types. * * @return the type of null if it wasn't one of the well known types. */ getSubAccountSecurityEnum(): SubAccountType; /** * Gets the sub account type that the security is from (e.g. CASH, MARGIN, SHORT, OTHER). * @see "Section 13.9.2.4.3, OFX Spec" * * @return the sub account fund for the transaction */ getSubAccountFund(): string; /** * Sets the sub account type that the security is from (e.g. CASH, MARGIN, SHORT, OTHER). * @see "Section 13.9.2.4.3, OFX Spec" * * @param subAcctFund the sub account fund for the transaction */ setSubAccountFund(subAcctFund: string): void; /** * Gets the result of getSubAccountFund as one of the well-known types. * * @return the type of null if it wasn't one of the well known types */ getSubAccountFundEnum(): SubAccountType; /** * Gets whether the income was tax exempt. This is an optional field according to the OFX spec. * @see "Section 13.9.2.4.3, OFX Spec" * * @return whether the transaction was tax exempt */ getTaxExempt(): boolean; /** * Sets whether the income was tax exempt. This is an optional field according to the OFX spec. * @see "Section 13.9.2.4.3, OFX Spec" * * @param taxExempt whether the transaction was tax exempt */ setTaxExempt(taxExempt: boolean): void; /** * Gets the withholding for the income. This is an optional field according to the OFX spec. * @see "Section 13.9.2.4.3, OFX Spec" * * @return the withholding */ getWithholding(): number; /** * Sets the withholding for the income. This is an optional field according to the OFX spec. * @see "Section 13.9.2.4.3, OFX Spec" * * @param withholding the withholding */ setWithholding(withholding: number): void; /** * Gets the currency code for the transaction. Only one of currency code or original currency * info should be set according to the OFX spec. If neither are set, means the default currency. * @see "Section 13.9.2.4.3, OFX Spec" * * @return the currency code for the transaction */ getCurrencyCode(): string; /** * Sets the currency code for the transaction. Only one of currency code or original currency * info should be set according to the OFX spec. If neither are set, means the default currency. * @see "Section 13.9.2.4.3, OFX Spec" * * @param currencyCode the currency code for the transaction */ setCurrencyCode(currencyCode: string): void; /** * Gets the original currency info for the transaction. * @see "Section 13.9.2.4.3, OFX Spec" * * @return the currency info for the transaction */ getOriginalCurrencyInfo(): OriginalCurrency; /** * Sets the original currency info for the transaction. * @see "Section 13.9.2.4.3, OFX Spec" * * @param originalCurrencyInfo the currency info for the transaction */ setOriginalCurrencyInfo(originalCurrencyInfo: OriginalCurrency): void; /** * Gets the 401K source for the sale. Should be one of "PRETAX", "AFTERTAX", "MATCH", * "PROFITSHARING", "ROLLOVER", "OTHERVEST", "OTHERNONVEST". This is an optional field * according to the OFX spec. * @see "Section 13.9.2.4.3, OFX Spec" * * @return the state withholding */ get401kSource(): string; /** * Sets the 401K source for the sale. Should be one of "PRETAX", "AFTERTAX", "MATCH", * "PROFITSHARING", "ROLLOVER", "OTHERVEST", "OTHERNONVEST". This is an optional field * according to the OFX spec. * @see "Section 13.9.2.4.3, OFX Spec" * * @param inv401kSource the state withholding */ set401kSource(inv401kSource: string): void; /** * Gets the 401(k) source as one of the well-known types. * * @return the type of close or null if it's not well known. */ get401kSourceEnum(): Inv401KSource; }