chatbot
clear chat
Skip to main content

Retrieve

GET 

/scenarios/:scenarioId/persons/:personId/incomes/pension/state/:pensionStateIncomeId

Provides information on a given income from the specified Household.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

    pensionStateIncomeId stringrequired

    The income's id

Responses

OK

Schema
    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.

    startWorkDate date-timerequired

    The first year that the person started working.

    startsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

    yearsNotWorkedSince int32required

    Years that remained unemployed since first year of work.

Loading...