@odoo/o-spreadsheet/dist/types/functions/module_financial.d.ts

A spreadsheet component

import { EvaluationError } from "../types/errors";
import { Arg, FunctionResultObject, Matrix, Maybe } from "../types/misc";
export declare const ACCRINTM: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, issue: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const AMORLINC: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cost: Maybe<FunctionResultObject>, purchaseDate: Maybe<FunctionResultObject>, firstPeriodEnd: Maybe<FunctionResultObject>, salvage: Maybe<FunctionResultObject>, period: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const COUPDAYS: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const COUPDAYBS: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const COUPDAYSNC: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const COUPNCD: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const COUPNUM: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const COUPPCD: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const CUMIPMT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, firstPeriod: Maybe<FunctionResultObject>, lastPeriod: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const CUMPRINC: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, firstPeriod: Maybe<FunctionResultObject>, lastPeriod: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const DB: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cost: Maybe<FunctionResultObject>, salvage: Maybe<FunctionResultObject>, life: Maybe<FunctionResultObject>, period: Maybe<FunctionResultObject>, ...args: Maybe<FunctionResultObject>[]) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const DDB: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cost: Maybe<FunctionResultObject>, salvage: Maybe<FunctionResultObject>, life: Maybe<FunctionResultObject>, period: Maybe<FunctionResultObject>, factor?: Maybe<FunctionResultObject>) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const DISC: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, price: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const DOLLARDE: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, fractionalPrice: Maybe<FunctionResultObject>, unit: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const DOLLARFR: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, decimalPrice: Maybe<FunctionResultObject>, unit: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const DURATION: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, securityYield: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const EFFECT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, nominal_rate: Maybe<FunctionResultObject>, periods_per_year: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const FV: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, paymentAmount: Maybe<FunctionResultObject>, presentValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const FVSCHEDULE: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, principalAmount: Maybe<FunctionResultObject>, rateSchedule: Arg) => number;
    isExported: true;
};
export declare const INTRATE: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, investment: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const IPMT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, currentPeriod: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const IRR: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cashFlowAmounts: Matrix<FunctionResultObject>, rateGuess?: Maybe<FunctionResultObject>) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const ISPMT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, currentPeriod: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const MDURATION: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, securityYield: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number;
    isExported: true;
};
export declare const MIRR: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cashflowAmount: Matrix<FunctionResultObject>, financingRate: Maybe<FunctionResultObject>, reinvestmentRate: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const NOMINAL: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, effective_rate: Maybe<FunctionResultObject>, periods_per_year: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const NPER: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, paymentAmount: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => number;
    isExported: true;
};
export declare const NPV: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, discount: Maybe<FunctionResultObject>, ...values: Arg[]) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const PDURATION: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const PMT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const PPMT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, currentPeriod: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const PV: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, rate: Maybe<FunctionResultObject>, numberOfPeriods: Maybe<FunctionResultObject>, paymentAmount: Maybe<FunctionResultObject>, futureValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>) => {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const PRICE: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, securityYield: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const PRICEDISC: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, discount: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const PRICEMAT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, issue: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, securityYield: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const RATE: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, numberOfPeriods: Maybe<FunctionResultObject>, paymentPerPeriod: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue?: Maybe<FunctionResultObject>, endOrBeginning?: Maybe<FunctionResultObject>, rateGuess?: Maybe<FunctionResultObject>) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const RECEIVED: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, investment: Maybe<FunctionResultObject>, discount: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const RRI: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, numberOfPeriods: Maybe<FunctionResultObject>, presentValue: Maybe<FunctionResultObject>, futureValue: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const SLN: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cost: Maybe<FunctionResultObject>, salvage: Maybe<FunctionResultObject>, life: Maybe<FunctionResultObject>) => {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const SYD: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cost: Maybe<FunctionResultObject>, salvage: Maybe<FunctionResultObject>, life: Maybe<FunctionResultObject>, period: Maybe<FunctionResultObject>) => EvaluationError | {
        value: number;
        format: string;
    };
    isExported: true;
};
export declare const TBILLPRICE: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, discount: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const TBILLEQ: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, discount: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const TBILLYIELD: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, price: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const VDB: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cost: Maybe<FunctionResultObject>, salvage: Maybe<FunctionResultObject>, life: Maybe<FunctionResultObject>, startPeriod: Maybe<FunctionResultObject>, endPeriod: Maybe<FunctionResultObject>, factor?: Maybe<FunctionResultObject>, noSwitch?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const XIRR: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, cashflowAmounts: Matrix<FunctionResultObject>, cashflowDates: Matrix<FunctionResultObject>, rateGuess?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const XNPV: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, discount: Maybe<FunctionResultObject>, cashflowAmounts: Arg, cashflowDates: Arg) => number | EvaluationError;
    isExported: true;
};
export declare const YIELD: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, price: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, frequency: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const YIELDDISC: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, price: Maybe<FunctionResultObject>, redemption: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};
export declare const YIELDMAT: {
    description: string;
    args: import("..").ArgDefinition[];
    compute: (this: import("..").EvalContext, settlement: Maybe<FunctionResultObject>, maturity: Maybe<FunctionResultObject>, issue: Maybe<FunctionResultObject>, rate: Maybe<FunctionResultObject>, price: Maybe<FunctionResultObject>, dayCountConvention?: Maybe<FunctionResultObject>) => number | EvaluationError;
    isExported: true;
};