Create
POST/scenarios/:scenarioId/persons/:personId/expenses/insurance-premium
Creates a new Insurance Premium for the given Person.
Request
Path Parameters
The scenario's id
The person's id
Query Parameters
Zero-based page index (0..N)
Default value: 20
The size of the page to be returned
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
- application/json
Body
required
The amount of the expense.
The currency of the expense. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The frequency of the expense.
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.
The id of the insurance that the expense associates.
The name of the resource.
properties object
Properties of the resource.
Properties of the resource.
Possible values: <= 1
Define the additional spread over the defined growthRate.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
The amount of the expense.
The currency of the expense. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]
The frequency of the expense.
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.
The id of the insurance that the expense associates.
The name of the resource.
properties object
Properties of the resource.
Properties of the resource.
Possible values: <= 1
Define the additional spread over the defined growthRate.
{
"amount": 70000,
"currency": "GBP",
"description": "My resource's description",
"frequency": "ANNUALLY",
"growthRate": "CALCULATED",
"id": "1",
"insuranceId": "6",
"name": "My resource",
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"spreadOverGrowthRate": 0
}
Not Found
Internal Server Error