Retrieve all
GET/scenarios/:scenarioId/persons/:personId/incomes/employer-pension-contribution
List all Employer Pension Contributions in a given household for a given person.
Request
Path Parameters
The scenario's id
The person's id
Query Parameters
Zero-based page index (0..N)
Default value: 20
The size of the page to be returned
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
content object[]
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.
pageable object
sort object
sort object
{
"content": [
{
"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"
}
}
],
"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
}
Not Found
Internal Server Error