chatbot
clear chat
Skip to main content

Create

POST 

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

Creates a new Employer Pension Contribution Income under the Person identified by {personId} from Household in the given scenario.

This income will go under one of the available tax wrappers defined for pension schemes and the funds will be available after retirement.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

Body

required
    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.

Responses

Created

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...