chatbot
clear chat
Skip to main content

Retrieve

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

Provides information on a given Employer Pension Contribution Income for the specified Person identified by {personId}.

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

    incomeId stringrequired

    The income's id

Responses​

OK

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.

Loading...