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

scenarioId stringrequired

The scenario's id

personId stringrequired

The person's id

Query Parameters

page integer

Zero-based page index (0..N)

size integer

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

content object[]
Array [
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.
]
empty boolean
first boolean
last boolean
number int32
numberOfElements int32
pageable object
offset int64
pageNumber int32
pageSize int32
paged boolean
sort object
empty boolean
sorted boolean
unsorted boolean
unpaged boolean
size int32
sort object
empty boolean
sorted boolean
unsorted boolean
totalElements int64
totalPages int32

Example (from schema)

{
  "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
}

404

Not Found

500

Internal Server Error

Loading...