Retrieve all

GET 
/scenarios/:scenarioId/expenses/portfolio-contribution

List all Portfolio Contribution Expenses in a given household.

Request

Path Parameters

scenarioId stringrequired

The scenario'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 amount of the expense.
currency stringrequired
The frequency of the expense.
description string
Description of the resource.
endDate date-timerequired
The end date of the expense.
endsOn stringrequired
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
frequency stringrequired
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The frequency of the expense.
growthRate stringrequired
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.
name string
The name of the resource.
portfolioId stringrequired
The portfolio ID this contribution refers to.
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 end date of the expense.
startsOn stringrequired
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
]
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": 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",
      "portfolioId": "6",
      "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"
    }
  ],
  "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...