Create
POST/scenarios/:scenarioId/expenses/mortgage
Create a Mortgage Expense
Request
Path Parameters
The scenario's id
- application/json
Body
required
The amount of the expense.
The frequency of the expense.
Description of the resource.
The end date of the expense.
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 expense.
The id of the resource.
The id of the mortgage that the expense associates.
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).
The end date of the expense.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
The amount of the expense.
The frequency of the expense.
Description of the resource.
The end date of the expense.
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 expense.
The id of the resource.
The id of the mortgage that the expense associates.
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).
The end date of the expense.
Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
{
"amount": 70000,
"currency": "ANNUALLY",
"description": "My resource's description",
"endDate": "2040-01-01T00:00:00.000Z",
"endsOn": "USER_DEFINED",
"frequency": "ANNUALLY",
"id": "1",
"mortgageId": "6",
"name": "My resource",
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"source": "Source of the resource",
"startDate": "2030-01-01T00:00:00.000Z",
"startsOn": "USER_DEFINED"
}
Not Found
Internal Server Error