Retrieve all

GET 
/scenarios/:scenarioId/goals/retirement

List all Retirement goals in a given household.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

Query Parameters

page integer

Zero-based page index (0..N)

size integer

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

content object[]
Array [
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
BankOfMumAndDadFundingSource
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
FutureInvestmentPropertyAssetFundingSource
description string
id string
name string
goalId string
The goal id of the Buy to Let goal associated to the property that will be sold in order to fund the goal.
FutureResidentialPropertyAssetFundingSource
description string
id string
name string
goalId string
The goal id of the Buy a House goal associated to the property that will be sold in order to fund the goal.
InvestmentPropertyFundingSource
description string
id string
name string
propertyAssetId string
The id of the investment property that will be sold in order to fund the goal.
LiquidAssetsFundingSource
description string
id string
name string
wrappers string[]
LiquidAssetsNoIncomeFundingSource
description string
id string
name string
wrappers string[]
MortgageFundingSource
description string
id string
name string
amount number
The funding source amount.
annualInterestRate double
Possible values: <= 1
The mortgage annual interest rate.
currency string
The funding source currency. Valid currency code ISO-4217 from the list of supported currencies.
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
maximumAbsoluteSpreadAllowed double
Possible values: <= 1
mortgageType string
Possible values: [FIXED_RATE, ADJUSTABLE_RATE]
The mortgage type. Can be any of (FIXED_RATE, ADJUSTABLE_RATE).
repaymentType string
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
The mortgage repayment type. Can be any of (PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT).
spreadOverGrowthRate double
Possible values: <= 1
termYears int32
The mortgage term years.
OtherLoanFundingSource
description string
id string
name string
amount number
The funding source amount.
annualInterestRate double
Possible values: <= 1
The loan annual interest rate.
currency string
The funding source amount.
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
maximumAbsoluteSpreadAllowed double
Possible values: <= 1
repaymentType string
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
The loan repayment type. Can be any of (PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT).
spreadOverGrowthRate double
Possible values: <= 1
termYears int32
The loan term years.
ResidentialPropertyFundingSource
description string
id string
name string
propertyAssetId string
The id of the residential property that will be sold in order to fund the goal.
SaveFundingSource
description string
id string
name string
saveInYears int32
The number of years for which you would like to save, in order to use the savings to fund the goal.
UKStudentLoanFundingSource
description string
id string
name string
amount number
The funding source amount.
currency string
The funding source amount.
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.
]
empty boolean
first boolean
last boolean
number int32
numberOfElements int32
pageable object
offset int64
pageNumber int32
pageSize int32
paged boolean
sort object
empty boolean
sorted boolean
unsorted boolean
unpaged boolean
size int32
sort object
empty boolean
sorted boolean
unsorted boolean
totalElements int64
totalPages int32

Example (from schema)

{
  "content": [
    {
      "currency": "GBP",
      "description": "My resource's description",
      "desiredAmount": 10000,
      "enabled": true,
      "endDate": "2026-01-01T00:00:00.000Z",
      "endsOn": "USER_DEFINED",
      "frequency": "ONE_OFF",
      "fundingSources": [
        {
          "class": "LiquidAssetsFundingSource",
          "description": "Liquid assets funding source",
          "name": "Liquid assets",
          "wrappers": [
            "GENERAL_INVESTMENT_ACCOUNT",
            "TAX_ADVANTAGED",
            "PENSION"
          ]
        }
      ],
      "growthRate": "CALCULATED",
      "id": "1",
      "maximumAbsoluteSpreadAllowed": 0,
      "minimumAmount": 10000,
      "name": "My resource",
      "percentageOfPreRetirementSpendAfterFirst10Years": 0.6,
      "percentageOfPreRetirementSpendFirst10Years": 0.9,
      "percentageOfSurvivorExpenditureSpend": 0.6,
      "priority": 1,
      "properties": {
        "property_1": "Value of property 1",
        "property_2": "Value of property 2"
      },
      "spreadOverGrowthRate": 0,
      "startDate": "2025-01-01T00:00:00.000Z",
      "startsOn": "USER_DEFINED",
      "tradeDownDate": "2050-01-01T00:00:00.000Z",
      "tradeDownHouse": true,
      "tradeDownNewHousePercentage": 0.75
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

404

Not Found

500

Internal Server Error

Loading...