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
The scenario's id
The person's id
- application/json
Body
required
The Income currency. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
The id of the earned income that this pension contribution associates.
Possible values: <= 1
Percentage of associated earned income that we should save.
The id of the resource.
Maximum employer contribution.
The name of the resource.
The portfolio ID that this pension contributes to.
properties object
Properties of the resource.
Properties of the resource.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
The Income currency. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
The id of the earned income that this pension contribution associates.
Possible values: <= 1
Percentage of associated earned income that we should save.
The id of the resource.
Maximum employer contribution.
The name of the resource.
The portfolio ID that this pension contributes to.
properties object
Properties of the resource.
Properties of the resource.
{
"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"
}
}
Not Found
Internal Server Error