Retrieve

GET 
/scenarios/:scenarioId/incomes/employer-pension-contribution/:incomeId

Retrieve an Employer Pension Contribution

Request

Path Parameters

scenarioId stringrequired

The scenario's id

incomeId stringrequired

The income's id

Responses

200

OK

application/json

Schema

Schema

currency stringrequired

The Income currency. Valid currency code ISO-4217 from the list of supported currencies.

description string

Description of the resource.

earnedIncomeId stringrequired

The id of the earned income that this pension contribution associates.

earnedIncomePercentSaved doublerequired

Possible values: <= 1

Percentage of associated earned income that we should save.

id string

The id of the resource.

maximumEmployerContribution numberrequired

Maximum employer contribution.

name string

The name of the resource.

portfolioId stringrequired

The portfolio ID that this pension contributes to.

properties object

Properties of the resource.

property name* object

Properties of the resource.

Example (from schema)

{
  "currency": "GBP",
  "description": "My resource's description",
  "earnedIncomeId": "4",
  "earnedIncomePercentSaved": 0,
  "id": "1",
  "maximumEmployerContribution": 0,
  "name": "My resource",
  "portfolioId": "6",
  "properties": {
    "property_1": "Value of property 1",
    "property_2": "Value of property 2"
  }
}

404

Not Found

500

Internal Server Error

Loading...