Skip to main content

Create

POST 

/scenarios/:scenarioId/persons/:personId/expenses/portfolio-contribution

Creates a new Portfolio contribution Expense for a Household in the given scenario.

Request

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

Body

required
    amount numberrequired

    The amount of the expense.

    currency stringrequired

    The frequency of the expense.

    description string

    Description of the resource.

    endDate date-timerequired

    The end date of the expense.

    endsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

    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.

    name string

    The name of the resource.

    portfolioId stringrequired

    The portfolio ID this contribution refers to.

    properties object

    Properties of the resource.

    property name* object

    Properties of the resource.

    source string

    Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).

    spreadOverGrowthRate double

    Possible values: <= 1

    Define the additional spread over the defined growthRate.

    startDate date-timerequired

    The end date of the expense.

    startsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

Responses

Created

Schema
    amount numberrequired

    The amount of the expense.

    currency stringrequired

    The frequency of the expense.

    description string

    Description of the resource.

    endDate date-timerequired

    The end date of the expense.

    endsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

    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.

    name string

    The name of the resource.

    portfolioId stringrequired

    The portfolio ID this contribution refers to.

    properties object

    Properties of the resource.

    property name* object

    Properties of the resource.

    source string

    Read-only field containing the source of the data (eg. if it was imported from a 3rd party service).

    spreadOverGrowthRate double

    Possible values: <= 1

    Define the additional spread over the defined growthRate.

    startDate date-timerequired

    The end date of the expense.

    startsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

Loading...