Retrieve

GET 
/scenarios/:scenarioId/liabilities/secured-debts/:liabilityId

Provides information on a given Secured Debt from the specified Household.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

liabilityId stringrequired

The liability's id

Responses

200

OK

application/json

Schema

Schema

amount numberrequired

The amount of the liability.

annualAverageInterestRate doublerequired

The annual average interest rate of the liability.

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.

name string

The name of the resource.

properties object

Properties of the resource.

property name* object

Properties of the resource.

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.

Example (from schema)

{
  "amount": 70000,
  "annualAverageInterestRate": 0.02,
  "currency": "GBP",
  "description": "My resource's description",
  "endDate": "2036-01-01T00:00:00.000Z",
  "id": "1",
  "name": "My resource",
  "properties": {
    "property_1": "Value of property 1",
    "property_2": "Value of property 2"
  },
  "repaymentType": "PRINCIPAL_AMORTIZATION",
  "source": "Source of the resource",
  "startDate": "2023-01-01T00:00:00.000Z"
}

404

Not Found

500

Internal Server Error

Loading...