Skip to main content

Retrieve

GET 

/scenarios/:scenarioId/goals/retirement/:goalId

Provides information on a given Goal from the specified Household.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    goalId stringrequired

    The goal's id

Responses

OK

Schema
    currency stringrequired

    The currency in which the goal's value is specified. Valid currency code ISO-4217 from the list of supported currencies.

    description string

    Description of the resource.

    desiredAmount number

    The desired value of the goal.

    enabled boolean

    Toggle inclusion of the goal in the simulation.

    endDate date-time

    End date of the goal. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with endsOn equals to USER_DEFINED.

    endsOn string

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

    frequency stringrequired

    Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

    The frequency of the goal.

    fundingSources object[]

    A list of funding sources.

  • Array [
  • oneOf
    description string
    id string
    name string
    amount number
    currency string
    growthRate string

    Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]

    maximumAbsoluteSpreadAllowed double

    Possible values: <= 1

    spreadOverGrowthRate double

    Possible values: <= 1

  • ]
  • growthRate string

    Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]

    Can be either of CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH.

    id string

    The id of the resource.

    maximumAbsoluteSpreadAllowed double

    Possible values: <= 1

    Maximum absolute spread added to growth rate allowed.

    minimumAmount numberrequired

    The minimum value of the goal.

    name string

    The name of the resource.

    percentageOfPreRetirementSpendAfterFirst10Years doublerequired

    The desired spend after 10 years of retirement expressed as a percentage of pre retirement spend.

    percentageOfPreRetirementSpendFirst10Years doublerequired

    The desired spend in the first 10 years after retirement expressed as a percentage of pre retirement spend.

    percentageOfSurvivorExpenditureSpend doublerequired

    Possible values: <= 1

    The desired spend after retirement in the situation when the partner has died, expressed as a percentage of pre retirement spend.

    priority int32required

    The priority of the goal (1 = lowest, 10 = highest).

    properties object

    Properties of the resource.

    property name* object

    Properties of the resource.

    spreadOverGrowthRate double

    Possible values: <= 1

    Define the additional spread over the defined growthRate.

    startDate date-timerequired

    Start date of the goal. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with startsOn equals to USER_DEFINED.

    startsOn string

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

    tradeDownDate date-time

    Date in which the property should be traded down.

    tradeDownHouse booleanrequired

    True if the the current house is to be traded for a cheaper one to fund retirement.

    tradeDownNewHousePercentage double

    Possible values: <= 1

    The value of the new house to be acquired after retirement, expressed as a percentage of the property the household members live in.

Loading...