Retrieve all
GET/scenarios/:scenarioId/persons/:personId/expenses/living
List all Living Expenses in a given household for a 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 amount of the expense.
The frequency of the expense.
Description of the resource.
The end date of the expense.
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Possible values: [UNSPECIFIED
, ONE_OFF
, DAILY
, WEEKLY
, MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
]
The frequency of the expense.
Possible values: [CALCULATED
, NONE
, CPI
, MEDIAN_WAGE_GROWTH
, PROPERTY_GROWTH
]
Can be either of CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH.
The id of the resource.
The name of the resource.
Possible values: <= 1
Percentage of expenditure considered non-discretionary.
properties object
Properties of the resource.
Properties of the resource.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
Possible values: <= 1
Define the additional spread over the defined growthRate.
The end date of the expense.
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Possible values: <= 1
Percentage of expenditure for the surviving partner.
pageable object
sort object
sort object
{
"content": [
{
"amount": 70000,
"currency": "ANNUALLY",
"description": "My resource's description",
"endDate": "2040-01-01T00:00:00.000Z",
"endsOn": "USER_DEFINED",
"frequency": "ANNUALLY",
"growthRate": "CALCULATED",
"id": "1",
"name": "My resource",
"nonDiscretionaryPercentage": 0.75,
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"source": "Source of the resource",
"spreadOverGrowthRate": 0,
"startDate": "2030-01-01T00:00:00.000Z",
"startsOn": "USER_DEFINED",
"survivorAdjustmentPercentage": 0.5
}
],
"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