Skip to main content

Create

POST 

/scenarios/:scenarioId/liabilities/secured-debts

Creates a new Secured Debt under the Household in the given scenario.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

Body

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

Responses

Created

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.

Loading...