RECEIVED
Returns the amount received at maturity for a fully invested security.
Syntax
expression.RECEIVED(arg1, arg2, arg3, arg4, arg6);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number | The security settlement date, expressed as a serial date number. | |
| arg2 | Required | ApiRange | ApiName | number | The maturity date of the security, expressed as a serial date number. | |
| arg3 | Required | ApiRange | ApiName | number | The amount invested in the security. | |
| arg4 | Required | ApiRange | ApiName | number | The security discount rate. | |
| arg6 | Optional | ApiRange | ApiName | number | The day count basis to use: -0 or omitted - US (NASD) 30/360; -1 - Actual/actual; -2 - Actual/360; -3 - Actual/365; -4 - European 30/360. |
Returns
number
Example
- Code
- Result
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.RECEIVED("1/1/2017", "6/1/2019", "$10,000.00", "3.75%", 2));