ofx4js
Version:
A javascript OFX library, ported from OFX4J
50 lines (49 loc) • 1.78 kB
TypeScript
import { BaseSellInvestmentTransaction } from "./BaseSellInvestmentTransaction";
import { SellDebtReason } from "./SellDebtReason";
/**
* Transaction for selling debt (i.e. bonds, CDs, etc.,).
* @see "Section 13.9.2.4.4, OFX Spec"
*/
export declare class SellDebtTransaction extends BaseSellInvestmentTransaction {
private sellReason;
private accruedInterest;
constructor();
/**
* Gets the reason for the sale. One of "CALL" (the debt was called), "SELL" (the debt was sold),
* "MATURITY" (the debt reached maturity).
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @return The reason for the sale
*/
getSellReason(): string;
/**
* Sets the reason for the sale. One of "CALL" (the debt was called), "SELL" (the debt was sold),
* "MATURITY" (the debt reached maturity).
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @param sellReason The reason for the sale
*/
setSellReason(sellReason: string): void;
/**
* Gets the sell reason as one of the well-known types.
*
* @return the sell reason or null if it's not well known
*/
getSellReasonEnum(): SellDebtReason;
/**
* Gets the amount of accrued interest on the debt. This is an optional field according to the
* OFX spec.
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @return the amount of accrued interest
*/
getAccruedInterest(): number;
/**
* Sets the amount of accrued interest on the debt. This is an optional field according to the
* OFX spec.
* @see "Section 13.9.2.4.4, OFX Spec"
*
* @param accruedInterest the amount of accrued interest
*/
setAccruedInterest(accruedInterest: number): void;
}