Retrieve all

GET 
/scenarios/:scenarioId/liabilities/mortgages

List all Mortgages in a given household.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

Query Parameters

page integer

Zero-based page index (0..N)

size integer

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

content object[]
Array [
amount numberrequired
The amount of the liability.
annualAverageInterestRate doublerequired
The annual average interest rate of the liability.
balanceAmount numberrequired
The balance amount.
balanceDate date-timerequired
The balance date.
currency stringrequired
The currency on which we hold that liability. Valid currency code ISO-4217 from the list of supported currencies.
description string
Description of the resource.
endDate date-timerequired
The end date of the liability.
id string
The id of the resource.
mortgageType stringrequired
Possible values: [FIXED_RATE, ADJUSTABLE_RATE]
The mortgage type (any of FIXED_RATE, ADJUSTABLE_RATE).
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 that this mortgage associates.
repaymentType stringrequired
Possible values: [PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT]
The liability repayment type (any of PRINCIPAL_AMORTIZATION, INTEREST_ONLY_WITH_BALLOON_PAYMENT).
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 starting date of the liability.
]
empty boolean
first boolean
last boolean
number int32
numberOfElements int32
pageable object
offset int64
pageNumber int32
pageSize int32
paged boolean
sort object
empty boolean
sorted boolean
unsorted boolean
unpaged boolean
size int32
sort object
empty boolean
sorted boolean
unsorted boolean
totalElements int64
totalPages int32

Example (from schema)

{
  "content": [
    {
      "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"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

404

Not Found

500

Internal Server Error

Loading...