Create

POST 
/scenarios/:scenarioId/persons/:personId/assets/portfolio

To create a portfolio under a person, use the extended URI including the person after the household.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

personId stringrequired

The person's id

application/json

Body

required

currency stringrequired

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

description string

Description of the resource.

fees doublerequired

The annual fees.

id string

The id of the resource.

name string

The name of the resource.

profile string

The risk profile of the portfolio.

properties object

Properties of the resource.

property name* object

Properties of the resource.

value numberrequired

The value of the portfolio.

wrapper stringrequired

The tax wrapper of the portfolio.

Responses

201

Created

application/json

Schema

Schema

currency stringrequired

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

description string

Description of the resource.

fees doublerequired

The annual fees.

id string

The id of the resource.

name string

The name of the resource.

profile string

The risk profile of the portfolio.

properties object

Properties of the resource.

property name* object

Properties of the resource.

value numberrequired

The value of the portfolio.

wrapper stringrequired

The tax wrapper of the portfolio.

Example (from schema)

{
  "currency": "GBP",
  "description": "My resource's description",
  "fees": 0.01,
  "id": "1",
  "name": "My resource",
  "profile": "low",
  "properties": {
    "property_1": "Value of property 1",
    "property_2": "Value of property 2"
  },
  "value": 70000,
  "wrapper": "isa"
}

404

Not Found

500

Internal Server Error

Loading...