Skip to main content

Retrieve

GET 
/scenarios/:scenarioId/persons/:personId/liabilities/mortgages/:liabilityId

Provides information on a given Mortgage from the specified Household and for a Person.

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

    liabilityId stringrequired

    The liability's id

Responses​

OK

Schema
    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.

Loading...