Create
POST/scenarios/:scenarioId/liabilities/mortgages
Creates a new Mortgage liability for the Household in the given scenario.
Request
Path Parameters
The scenario's id
- application/json
Body
required
The amount of the liability.
The annual average interest rate of the liability.
The balance amount.
The balance date.
The currency on which we hold that liability. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
The end date of the liability.
The id of the resource.
Possible values: [FIXED_RATE, ADJUSTABLE_RATE]
The mortgage type (any of FIXED_RATE, ADJUSTABLE_RATE).
The name of the resource.
properties object
Properties of the resource.
Properties of the resource.
The id of the property that this mortgage associates.
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
The liability repayment type (any of PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT).
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
The starting date of the liability.
Responses
- 201
- 404
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
The amount of the liability.
The annual average interest rate of the liability.
The balance amount.
The balance date.
The currency on which we hold that liability. Valid currency code ISO-4217 from the list of supported currencies.
Description of the resource.
The end date of the liability.
The id of the resource.
Possible values: [FIXED_RATE, ADJUSTABLE_RATE]
The mortgage type (any of FIXED_RATE, ADJUSTABLE_RATE).
The name of the resource.
properties object
Properties of the resource.
Properties of the resource.
The id of the property that this mortgage associates.
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
The liability repayment type (any of PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT).
Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).
The starting date of the liability.
{
"amount": 70000,
"annualAverageInterestRate": 0.02,
"balanceAmount": 200000,
"balanceDate": "2023-01-01T00:00:00.000Z",
"currency": "GBP",
"description": "My resource's description",
"endDate": "2036-01-01T00:00:00.000Z",
"id": "1",
"mortgageType": "FIXED_RATE",
"name": "My resource",
"properties": {
"property_1": "Value of property 1",
"property_2": "Value of property 2"
},
"propertyAssetId": "7",
"repaymentType": "PRINCIPAL_AMORTIZATION",
"source": "Source of the resource",
"startDate": "2023-01-01T00:00:00.000Z"
}
Not Found
Internal Server Error