Skip to main content

Retrieve all

GET 

/scenarios/:scenarioId/persons/:personId/expenses/living

List all Living Expenses in a given household for a 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

OK

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.

    nonDiscretionaryPercentage doublerequired

    Possible values: <= 1

    Percentage of expenditure considered non-discretionary.

    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.

    survivorAdjustmentPercentage double

    Possible values: <= 1

    Percentage of expenditure for the surviving partner.

  • ]
  • 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
Loading...