ofx4js
Version:
A javascript OFX library, ported from OFX4J
63 lines (62 loc) • 2.12 kB
TypeScript
import { BaseSellInvestmentTransaction } from "./BaseSellInvestmentTransaction";
import { SellType } from "./SellType";
/**
* Transaction for selling mutual fund.
* @see "Section 13.9.2.4.4, OFX Spec"
*/
export declare class SellMutualFundTransaction extends BaseSellInvestmentTransaction {
private sellType;
private averageCostBasis;
private relatedTransactionId;
constructor();
/**
* Gets the type of sale. One of "SELL" or "SELLSHORT".
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @return The type of sale
*/
getSellType(): string;
/**
* Sets the type of sale. One of "SELL" or "SELLSHORT".
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @param sellType The type of sale
*/
setSellType(sellType: string): void;
/**
* Gets the sell type as one of the well-known types.
*
* @return the type of sale or null if it's not known.
*/
getSellTypeEnum(): SellType;
/**
* Gets the average cost basis of the sale.
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @return The average cost basis of the sale
*/
getAverageCostBasis(): number;
/**
* Sets the average cost basis of the sale.
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @param averageCostBasis The average cost basis of the sale
*/
setAverageCostBasis(averageCostBasis: number): void;
/**
* Gets any related transaction id for a mutual fund sale (e.g. for a mutual fund exchange).
* This is an optional field according to the OFX spec.
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @return the related transaction id
*/
getRelatedTransactionId(): string;
/**
* Sets any related transaction id for a mutual fund sale (e.g. for a mutual fund exchange).
* This is an optional field according to the OFX spec.
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @param relatedTransactionId the related transaction id
*/
setRelatedTransactionId(relatedTransactionId: string): void;
}