chatbot
clear chat
Skip to main content

Retrieve

GET 
/scenarios/:scenarioId/persons/:personId/assets/portfolio/:portfolioId/financial/:assetId

Provides information on a given financial asset belonging to a person from the specified household.

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

    personId stringrequired

    The person's id

    portfolioId stringrequired

    The portfolio's id

    assetId stringrequired

    The asset's id

Responses​

OK

Schema
    assetClass stringrequired

    The ID of the asset class. Please refer to Asset Classes for more details.

    city string

    The city in the country of the asset.

    country string

    The country of the asset.

    currency stringrequired

    The currency in which the value is expressed. Valid currency code ISO-4217 from the list of supported currencies.

    description string

    Description of the resource.

    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.

    region string

    The region in the country of the asset.

    source string

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

    state string

    The state in the country of the asset.

    valuationDate date-timerequired

    The valuation date of the asset.

    value numberrequired

    The value of the asset.

Loading...