Retrieve all

GET 
/scenarios/:scenarioId/persons/:personId/incomes/unearned

List all Unearned Incomes 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 [
amount numberrequired
The income amount.
currency stringrequired
The Income currency. Valid currency code ISO-4217 from the list of supported currencies.
description string
Description of the resource.
endDate date-timerequired
The Income end date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with endsOn equals to USER_DEFINED.
endsOn stringrequired
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
frequency string
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The frequency of the income.
growthRate string
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
Can be either of CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH.
id string
The id of the resource.
maximumAbsoluteSpreadAllowed double
Possible values: <= 1
name string
The name of the resource.
properties object
Properties of the resource.
property name* object
Properties of the resource.
source string
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
spreadOverGrowthRate double
Possible values: <= 1
Define the additional spread over the defined growthRate.
startDate date-timerequired
The Income start date. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with startsOn equals to USER_DEFINED.
startsOn stringrequired
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
taxable boolean
Whether this unearned income is taxable or not.
toSurvivorPercentage double
Possible values: <= 1
% of the income to be transferred to the surviving partner.
type string
Possible values: [ALIMONY, DEFINED_BENEFIT_PENSION, NON_SALARIED_INCOME, CHILD_SUPPORT, INHERITANCE, WINDFALL, OTHER]
Can be either of ALIMONY, DEFINED_BENEFIT_PENSION, NON_SALARIED_INCOME, CHILD_SUPPORT, INHERITANCE, WINDFALL, OTHER.
]
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": [
    {
      "amount": 75000,
      "currency": "GBP",
      "description": "My resource's description",
      "endDate": "2040-01-01T00:00:00.000Z",
      "endsOn": "USER_DEFINED",
      "frequency": "ANNUALLY",
      "growthRate": "CALCULATED",
      "id": "1",
      "maximumAbsoluteSpreadAllowed": 0.05,
      "name": "My resource",
      "properties": {
        "property_1": "Value of property 1",
        "property_2": "Value of property 2"
      },
      "source": "Source of the resource",
      "spreadOverGrowthRate": 0.02,
      "startDate": "2031-01-01T00:00:00.000Z",
      "startsOn": "USER_DEFINED",
      "taxable": true,
      "toSurvivorPercentage": 0.9,
      "type": "OTHER"
    }
  ],
  "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...