ofx4js
Version:
A javascript OFX library, ported from OFX4J
144 lines (143 loc) • 5.33 kB
TypeScript
import { BaseOtherInvestmentTransaction } from "./BaseOtherInvestmentTransaction";
import { SecurityId } from "../../seclist/SecurityId";
import { OriginalCurrency } from "./OriginalCurrency";
import { SubAccountType } from "../accounts/SubAccountType";
import { Inv401KSource } from "../positions/Inv401KSource";
/**
* Transaction for an investment expense
* @see "Section 13.9.2.4.4, OFX Spec"
*/
export declare class InvestmentExpenseTransaction extends BaseOtherInvestmentTransaction {
private securityId;
private total;
private subAccountSecurity;
private subAccountFund;
private currencyCode;
private originalCurrencyInfo;
private inv401kSource;
constructor();
/**
* Gets the id of the security for the expense. This is a required field according to the OFX
* spec.
* @see "Section 13.9.2.4.3, OFX Spec"
*
* @return the security id of the security for the expsense
*/
getSecurityId(): SecurityId;
/**
* Sets the id of the security for the expense. This is a required field according to the OFX
* spec.
* @see "Section 13.9.2.4.3, OFX Spec"
*
* @param securityId the security id of the security for the expsense
*/
setSecurityId(securityId: SecurityId): void;
/**
* Gets the total for the expense.
* @see "Section 13.9.2.4.3, OFX Spec"
*
* @return the total
*/
getTotal(): number;
/**
* Sets the total for the expense.
* @see "Section 13.9.2.4.3, 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 subAccountSecurity the sub account type
*/
setSubAccountSecurity(subAccountSecurity: 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 for the fund. (e.g. CASH, MARGIN, SHORT, OTHER).
* @see "Section 13.9.2.4.3, OFX Spec"
*
* @return the sub account fund
*/
getSubAccountFund(): string;
/**
* Sets the sub account type for the fund. (e.g. CASH, MARGIN, SHORT, OTHER).
* @see "Section 13.9.2.4.3, OFX Spec"
*
* @param subAccountFund the sub account fund
*/
setSubAccountFund(subAccountFund: 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 the currency code for the transaction. Only one of currency code or original currency
* code 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
* code 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 original 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 original currency info for the transaction
*/
setOriginalCurrencyInfo(originalCurrencyInfo: OriginalCurrency): void;
/**
* Gets the 401K source for the transaction. 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 401k source
*/
get401kSource(): string;
/**
* Sets the 401K source for the transaction. 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 401k source
*/
set401kSource(inv401kSource: string): void;
/**
* Gets the 401k source as one of the well-known types.
*
* @return the 401k source or null if its not one of the well-known types
*/
get401kSourceEnum(): Inv401KSource;
}