Overview
Version information
Version 0.1.0
Contact information
Contact: EValue Support - support@ev.uk
URI scheme
Schemes: HTTP, HTTPS
Consumes
application/json
Produces
application/json
Paths
/chanceCapitalLossForecast/forecast
Description
The Chance of Capital Loss API is an upgrade to the Investment Forecast API which shows the probability of losing money on the capital invested. It uses the same request parameters as the Investment Forecast API and generates the chance of the investment being worth less than the original investment, plus additional contributions (as a percentage) for each of the requested terms. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
| Type |
Name |
Description |
Schema |
Required |
| BodyParameter |
body |
Parameters for chance of beating capital loss forecast |
ChanceCapitalLossParameters |
true |
Responses
Definitions
Request
Please note that only the following Definitions will be used when calculating the Result of this API call. Any other data submitted will not be validated or used in the calculation.
ChanceCapitalLossParameters
| Name |
Description |
Schema |
Required |
Range |
| contributions |
The regular contributions to be forecast |
Contributions |
|
|
| withdrawals |
The regular withdrawals to be forecast |
Withdrawals |
|
|
| initialCharges |
The initial charges to be forecast |
InitialCharges |
|
|
| annualCharges |
The annual charges to be forecast |
AnnualCharges |
|
|
| accumulationTaxationBasis |
Choice of taxation basis for investment: either no tax adjustment or apply a 0.5% deduction to allow for taxation, in line with FCA rules. |
Enum - NONE, FCA_TAXED |
true |
|
| funds |
Choice of funds for the investment to be invested in. |
List of Fund |
true |
|
| forecastOptions |
Options for how the forecast is calculated. |
ForecastOptions |
true |
|
Contributions
| Name |
Description |
Schema |
Required |
Range |
| amount |
Regular contribution to be included in the forecast |
Double |
true |
|
| frequency |
Frequency of regular monetary amount contributions |
Enum - WEEKLY, MONTHLY, QUARTERLY, ANNUALLY |
true |
|
| increase |
Increase to apply to pound-amount regular contributions (Increase applied annually). If an increase is required for percentage contributions then please use the salary increase |
Increase |
|
|
Increase
| Name |
Description |
Schema |
Required |
Range |
| basis |
The underlying index to base the increase on. This can be one of NONE, RPI, CPI or AWE (average weekly earnings) |
Enum - NONE, RPI, CPI, AWE |
|
|
| rate |
An additional rate of increase to apply each year on top of the increase basis. For a fixed increase rate basis should be set to NONE and rate to the fixed increase (i.e. basis = NONE, rate = 2.5 would use fixed 2.5% increases each year) |
Double |
|
-100 to 100 |
Withdrawals
| Name |
Description |
Schema |
Required |
Range |
| percentage |
A boolean entry to determine if the withdrawals made from the investment should be a pound amount (false) or a percentage of the fund (true) |
Boolean |
true |
|
| amount |
The amount to withdraw from the fund on an annual basis. If percentage has been specified, then the amount should release to the annual percentage required e.g. 2.5 for 2.5% per annum |
Double |
true |
|
| increase |
Increase to apply to regular withdrawals. (Increase applied annually.) |
Increase |
|
|
| startDate |
The date you would like the withdrawal from assets to start |
String (date) |
|
|
InitialCharges
| Name |
Description |
Schema |
Required |
Range |
| percentage |
Initial charge applied to the starting balance (as % of balance) |
Double |
|
0 to 100 |
| amount |
Initial charge applied to the starting balance (in pound amount terms) |
Double |
|
0 to 99,999 |
| contributionPercentage |
Initial charge applied to any future contributions upon deposit (as % of contribution) |
Double |
|
0 to 100 |
AnnualCharges
| Name |
Description |
Schema |
Required |
Range |
| amount |
Annual pound amount charge. |
Double |
|
0 to 99,999 |
| tieredCharges |
Charges to apply at different tiers. Please provide these tiers in order from smallest to largest upperLimit. |
List of TieredCharge |
|
|
TieredCharge
| Name |
Description |
Schema |
Required |
Range |
| percentage |
Annual % pa charge to apply to product (excluding fund charge) |
Double |
|
0 to 100 |
| upperLimit |
Balance up to which to apply the annual % charge specificied. If excluded, assume charge applies to whole balance |
Double |
|
0 to 999,999,999 |
Fund
| Name |
Description |
Schema |
Required |
Range |
| code |
Enter fund code for forecast. Use Citicode or asset class - see documentation for further information on asset class codes. |
String |
true |
|
| riskGroup |
User's risk benchmark to which their investment can be evaluated |
Integer |
|
|
| riskTerm |
Evaluated term for the efficient risk profile. Required if riskGroup is set. |
Integer |
|
0 to 75 |
| balance |
Balance in this fund |
Double |
true |
-999,999,999 to 999,999,999 |
| contributionPercentage |
Contribution percentage allocated to that fund. |
Double |
true |
-100 to 200 |
| adjustment |
Fund charge to apply to this fund. Enter charges as positive value, e.g. 1.5 for a 1.5% pa fund charge. |
Double |
|
-99 to 99 |
| portfolioFunds |
A portfolio of funds. |
List of PortfolioFund |
|
|
PortfolioFund
| Name |
Description |
Schema |
Required |
Range |
| code |
Enter fund code for forecast. Use Citicode or asset class - see documentation for further information on asset class codes. |
String |
true |
|
| contributionPercentage |
Contribution percentage allocated to that fund. |
Double |
true |
-100 to 200 |
ForecastOptions
| Name |
Description |
Schema |
Required |
Range |
| terms |
Terms for which to return a result, between 0 and 75 years |
List of Integer |
true |
|
Response
ChanceCapitalLossResult
| Name |
Description |
Schema |
| terms |
A list of result for each term requested in the API input parameters |
List of ChanceTermResult |
ChanceTermResult
| Name |
Description |
Schema |
| term |
The term of this forecast result |
Integer |
| chance |
The chance of capital loss as a percentage |
Double |
ValidationErrors
| Name |
Description |
Schema |
| errors |
A list of errors from validating the API input parameters |
List of ValidationError |
ValidationError
| Name |
Description |
Schema |
| field |
The field that is invalid |
String |
| code |
The type of validation error that has occurred |
Enum - REQUIRED, OUT_OF_RANGE, INVALID, INVALID_TOTAL |
| message |
The validation error message |
String |
| value |
The value that is invalid |
String |
SystemError
| Name |
Description |
Schema |
| systemError |
The system error message. |
String |
Asset Classes
Where fund codes are required as input, you can instead refer to asset classes. See list of codes you can use for assets below.
| Code |
Description |
| Returns_File_Cash |
Cash |
| Returns_File_Government_Bonds |
UK Government Bonds |
| Returns_File_Index_Linked_Bonds |
UK Index Linked Bonds |
| Returns_File_Corporate_Bonds_Inv_Grade |
Corporate Bonds - Investment Grade |
| Returns_File_Corporate_Bonds_High_Yield |
Global High Yield Bonds |
| Returns_File_Global_government_bonds |
Global Bonds |
| Returns_File_UK_Equity |
UK Equity |
| Returns_File_US_Equity |
US Equity |
| Returns_File_Europe_Equity |
European Equity |
| Returns_File_Japan_Equity |
Japanese Equity |
| Returns_File_Asia_ex_Japan_Equity |
Asia ex Japan Equity |
| Returns_File_Global_Emerging_Market_Equity |
Emerging Markets Equity |
| Returns_File_Small_cap_UK |
UK Small Cap Equity |
| Returns_File_Property |
UK Property |
| Returns_File_International_property |
International Property |
| Returns_File_Alpha_Strategies |
Alternative Investments |
| Returns_File_Commodities |
Commodities |
| Returns_File_Inflation |
Price Inflation |
| Returns_File_Nil_return |
Nil return |
