chatbot
clear chat
Skip to main content

Retrieve

GET 

/scenarios/:scenarioId/persons/:personId/incomes/rent/:incomeId

Provides information on a given Rent income from the specified Person in the given Household.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

    incomeId stringrequired

    The income's id

Responses

OK

Schema
    annualNetRentalYieldPercentage doublerequired

    Possible values: <= 1

    The annual net rental yield percentage.

    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.

    id string

    The id of the resource.

    name string

    The name of the resource.

    properties object

    Properties of the resource.

    property name* object

    Properties of the resource.

    propertyAssetId stringrequired

    The id of the property asset that generates this income.

    source string

    Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).

    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.

    toSurvivorPercentage double

    Possible values: <= 1

    % of the income to be transferred to the surviving partner.

Loading...