Update
PUT/scenarios/:scenarioId/persons/:personId/incomes/earned/:earnedIncomeId
Updates an Earned Income under the Person identified by {personId} from Household in the given scenario.
Request
Path Parameters
The scenario's id
The person's id
The income's id
- application/json
Body
required
The income amount.
The Income currency. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
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.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The frequency of the income.
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
Can be either of CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH.
The id of the resource.
Possible values: <= 1
The name of the resource.
properties object
Properties of the resource.
Properties of the resource.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
Possible values: <= 1
Define the additional spread over the defined growthRate.
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.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
The income amount.
The Income currency. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
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.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The frequency of the income.
Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]
Can be either of CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH.
The id of the resource.
Possible values: <= 1
The name of the resource.
properties object
Properties of the resource.
Properties of the resource.
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
Possible values: <= 1
Define the additional spread over the defined growthRate.
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.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
{
"amount": 75000,
"currency": "GBP",
"description": "My resource's description",
"endDate": "2040-01-01T00:00:00.000Z",
"endsOn": "USER_DEFINED",
"frequency": "ANNUALLY",
"growthRate": "CALCULATED",
"id": "1",
"maximumAbsoluteSpreadAllowed": 0.05,
"name": "My resource",
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"source": "Source of the resource",
"spreadOverGrowthRate": 0.02,
"startDate": "2031-01-01T00:00:00.000Z",
"startsOn": "USER_DEFINED"
}
Not Found
Internal Server Error