m8ty-dto - m8ty Data Transfer Objects/eu.m8ty.dtos.portfolios

Package-level declarations

Types

data class AssetGroupDto(var amount: AmountDto, var items: MutableList<AssetGroupItemDto>, var groupType: AssetGroupEnumDto? = null, var dateTimeValuation: OffsetDateTime? = null)

Information about the entire Asset Group.

AssetGroupedOverviewResponseDto

data class AssetGroupedOverviewResponseDto(var assetGroups: MutableList<AssetGroupDto>, var page: PageDto)

Describes the grouped overview of all assets.

AssetGroupEnumDto

enum AssetGroupEnumDto : Enum<AssetGroupEnumDto>

Enum to specify the asset grouping.

ASSET_TYPE - Grouped by asset type
CURRENCY - Grouped by currency
INDUSTRY_TYPE - Grouped by industry type

Values: ASSET_TYPE,CURRENCY,INDUSTRY_TYPE

AssetGroupItemDto

data class AssetGroupItemDto(var amountInReferenceCurrency: BigDecimal, var description: String, var isCashAccount: Boolean)

Item of an asset group.

AssetPortfolioItemDto

data class AssetPortfolioItemDto(var assetId: String? = null, var assetNumber: String? = null, var assetType: AssetTypeEnumDto? = null, var amount: AmountDto? = null)

Item of a portfolio asset.

AssetPortfolioOverviewResponseDto

data class AssetPortfolioOverviewResponseDto(var assets: MutableList<AssetPortfolioItemDto>? = null, var page: PageDto? = null)

Overview of the assets in a portfolio.

AssetsTotalOverviewResponseDto

data class AssetsTotalOverviewResponseDto(var items: MutableList<AssetTotalItemDto>? = null)

Overview list of the the totals and asset types.

AssetTotalItemDto

data class AssetTotalItemDto(var name: AssetTypeEnumDto, var total: AmountDto? = null)

Item object containing the name of the asset type and it's total.

AssetTypeEnumDto

enum AssetTypeEnumDto : Enum<AssetTypeEnumDto>

Enum to specify the asset type.

ACCOUNT - Assets of an account
ACCOUNT_CUSTODY - Assets of an account managed by a custody.
PENSION - Assets of a pension
MORTGAGE - Loan mortgages

Values: ACCOUNT,ACCOUNT_CUSTODY,PENSION,MORTGAGE

MaturitiesOverviewResponseDto

data class MaturitiesOverviewResponseDto(var maturities: MutableList<MaturityDto>, var page: PageDto)

Overview of maturities of the portfolio.

MaturityDto

data class MaturityDto(var id: String, var dateValue: LocalDate, var amountFactor: Int? = 1, var callAmount: AmountDto? = null)

Maturity of the portfolio. The callAmount describes the value on call.

MortgageDto

data class MortgageDto(var mortgageId: String, var customerId: String, var mortgageAmount: AmountDto, var mortgageName: String? = null, var address: AddressDto? = null)

A loan secured by real estate, used to finance property purchases.

MortgagesResponseDto

data class MortgagesResponseDto(var mortgages: MutableList<MortgageDto>, var page: PageDto)

Response containing all requested mortgages of a user.

MortgagesSearchRequestDto

data class MortgagesSearchRequestDto(var customerId: String? = null)

Request object for mortgages data search

PensionDto

data class PensionDto(var pensionId: String, var customerId: String, var pensionCurrency: CurrencyDto, var balance: AmountDto, var pensionName: String? = null, var pensionTypeDescription: String? = null, var pensionDescription: String? = null)

A tax-advantaged savings account, part of the three-pillar pension system.

PensionSearchRequestDto

data class PensionSearchRequestDto(var customerId: String? = null)

Request object for pension data search

PensionsResponseDto

data class PensionsResponseDto(var pensions: MutableList<PensionDto>, var page: PageDto)

Response containing all requested pensions of a user.

PerformanceDto

data class PerformanceDto(var amountYtd: BigDecimal? = null, var percentTimeWeightedYtd: BigDecimal? = null, var percentMoneyWeightedYtd: BigDecimal? = null, var percentReturn: BigDecimal? = null, var percentReturnCumulated: BigDecimal? = null)

Describes the performance of the portfolio.

PortfolioDto

data class PortfolioDto(var id: String, var isin: String, var amount: AmountDto, var name: String? = null, var alias: String? = null, var shortDescription: String? = null, var additionalInformation: String? = null, var managementType: String? = null, var sourceIdentifier: PortfolioSourceIdentifierDto? = null, var amountInReferenceCurrency: AmountDto? = null, var valuationDateTime: OffsetDateTime? = null, var intraday: Boolean? = null, var performance: PerformanceDto? = null)

Includes a list of portfolios of the customer.

PortfolioResponseDto

data class PortfolioResponseDto(var portfolios: MutableList<PortfolioDto>, var page: PageDto)

Includes a list of portfolios of the customer.

PortfolioSourceIdentifierDto

data class PortfolioSourceIdentifierDto(var customerId: String, var customerNo: String, var custodyAccountId: String? = null)

Identifier of the source/partner where the portfolio is held in custody.