Skip to main content

Retrieve

GET 
/scenarios/:scenarioId/persons/:personId/expenses/insurance-premium/:expenseId

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

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

    expenseId stringrequired

    The expense's id

Responses​

OK

Schema
    amount numberrequired

    The amount of the expense.

    currency stringrequired

    The currency of the expense. Valid currency code ISO-4217 from the list of supported currencies.

    description string

    Description of the resource.

    frequency stringrequired

    Possible values: [UNSPECIFIED, ONE_OFF, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

    The frequency of the expense.

    growthRate stringrequired

    Possible values: [CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH]

    Can be either of CALCULATED, NONE, CPI, MEDIAN_WAGE_GROWTH, PROPERTY_GROWTH.

    id string

    The id of the resource.

    insuranceId stringrequired

    The id of the insurance that the expense associates.

    name string

    The name of the resource.

    properties object

    Properties of the resource.

    property name* object

    Properties of the resource.

    spreadOverGrowthRate double

    Possible values: <= 1

    Define the additional spread over the defined growthRate.

Loading...