Create

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

Creates a new Rent Income under the given household and person.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

personId stringrequired

The person's id

application/json

Body

required

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.

Responses

201

Created

application/json

Schema

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.

Example (from schema)

{
  "annualNetRentalYieldPercentage": 0.05,
  "description": "My resource's description",
  "endDate": "2040-01-01T00:00:00.000Z",
  "endsOn": "USER_DEFINED",
  "id": "1",
  "name": "My resource",
  "properties": {
    "property_1": "Value of property 1",
    "property_2": "Value of property 2"
  },
  "propertyAssetId": "6",
  "source": "Source of the resource",
  "startDate": "2031-01-01T00:00:00.000Z",
  "startsOn": "USER_DEFINED",
  "toSurvivorPercentage": 0.9
}

404

Not Found

500

Internal Server Error

Loading...