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

Package-level declarations

Types

data class AssetIndustryDto(var code: String, var text: String)

Industry to which the asset belongs.

data class CustodyAccountDto(var id: String, var customerId: String, var custodyAccountValues: CustodyAccountValuesDto, var custodyAccountNumber: String? = null, var custodyAccountName: String? = null, var custodyAccountDescription: String? = null, var custodyAccountDescriptionAlternative: String? = null, var accruedInterest: BigDecimal? = null, var portfolioId: String? = null, var permissions: MutableList<CustodyAccountPermissionEnumDto>? = null)

Describes a custody account.

CustodyAccountPermissionEnumDto

enum CustodyAccountPermissionEnumDto : Enum<CustodyAccountPermissionEnumDto>

Maps the authorisations of a custody account.

BROKERAGE_READ_ONLY Authorisations for the stock market as read-only rights (default).
BROKERAGE_EXECUTION All rights for the stock market - securities account can be used for brokerage transactions.
BROKERAGE_POSITIONS_ONLY - Restricts user access to securities account positions with position authorisations.

Values: BROKERAGE_READ_ONLY,BROKERAGE_EXECUTION,BROKERAGE_POSITIONS_ONLY

CustodyAccountSearchRequestDto

data class CustodyAccountSearchRequestDto(var portfolioId: String? = null, var customerId: String? = null)

Search parameters for custody accounts. Each parameter is optional. If all fields are left empty, all of the user's accounts are returned.

CustodyAccountSearchResponseDto

data class CustodyAccountSearchResponseDto(var custodyAccounts: MutableList<CustodyAccountDto>, var page: PageDto)

List of custody accounts found.

CustodyAccountValuesDto

data class CustodyAccountValuesDto(var lastValueDate: LocalDate, var custodyAccount: AmountDto, var userPreferred: AmountDto, var portfolio: AmountDto? = null, var lastEndYear: AmountDto? = null)

Current value position of the custody account in the currencies used by the user..

custodyAccount - Value of the custody account in the currency of the account.
userPreferred - Value of the portfolio in the customer's preferred currency.
portfolio - Value of the custody account in the currency of the portfolio.
lastEndYear - The last year-end value of the custody account.

CustodyPositionAmountsDto

data class CustodyPositionAmountsDto(var unitAmount: AmountDto, var unit: SecurityUnitTypeEnumDto, var specialAmount: AmountDto? = null, var accruedInterest: BigDecimal? = null)

Describes the amounts of a position. The specialAmount refers to a possible second amount in the unit defined for the security. It is used specifically for forward transactions or special bond positions.

CustodyPositionDetailsDto

data class CustodyPositionDetailsDto(var industry: AssetIndustryDto, var assetName: String? = null, var securitySymbol: String? = null, var dividendFrequency: DividendFrequencyEnumDto? = null, var descriptionText: String? = null, var descriptions: MutableList<String>? = null, var securityType: SecurityTypeDto? = null, var securityTypeClassL1: SecurityTypeDto? = null, var securityTypeClassL2: SecurityTypeDto? = null, var intraday: Boolean? = null)

Details of the position and the asset.

CustodyPositionDto

data class CustodyPositionDto(var id: String, var custodyAccountId: String, var details: CustodyPositionDetailsDto, var permissions: CustodyPositionPermissionsDto, var amounts: CustodyPositionAmountsDto, var positionValues: CustodyPositionValuesDto, var portfolioId: String? = null, var isin: String? = null, var securityNumber: String? = null, var creationDate: OffsetDateTime? = null, var prices: CustodyPositionPriceDto? = null, var maturityDetails: CustodyPositionMaturityDto? = null, var stockExchange: CustodyPositionStockExchangeDto? = null)

Position of a custody account.

CustodyPositionGroupDto

data class CustodyPositionGroupDto(var groupName: String, var groupTotalAmount: AmountDto, var percentage: BigDecimal? = null)

Single group of custody position with the name and amount.

CustodyPositionMaturityDto

data class CustodyPositionMaturityDto(var maturityDate: LocalDate? = null, var daysUntilMaturity: Int? = null)

Details for the maturity date.

CustodyPositionPermissionsDto

data class CustodyPositionPermissionsDto(var buy: Boolean, var sell: Boolean)

Permissions to buy/sell the asset.

CustodyPositionPriceDto

data class CustodyPositionPriceDto(var price: BigDecimal? = null, var priceDateTime: OffsetDateTime? = null, var costPrice: BigDecimal? = null, var costPriceDateTime: OffsetDateTime? = null, var foreignExchangeRate: BigDecimal? = null, var amountForeignCurrency: BigDecimal? = null)

Depicts the current price information.

CustodyPositionsOverviewDto

data class CustodyPositionsOverviewDto(var positionGroups: MutableList<CustodyPositionGroupDto>, var totalPositionsAmount: AmountDto)

Overview data for groups of Custody Positions.

CustodyPositionsSearchRequestDto

data class CustodyPositionsSearchRequestDto(var portfolioId: String? = null, var maturityOnly: Boolean? = null)

Search parameter for the search for positions in a custody account.

CustodyPositionsSearchResponseDto

data class CustodyPositionsSearchResponseDto(var positions: MutableList<CustodyPositionDto>, var page: PageDto)

Result object for the search for positions in a custody account.

CustodyPositionStockExchangeDto

data class CustodyPositionStockExchangeDto(var name: String? = null, var alias: String? = null)

Information about the stock exchange.

CustodyPositionValueProfitDto

data class CustodyPositionValueProfitDto(var amountForward: BigDecimal? = null, var percentBasedOnExchangeRate: BigDecimal? = null, var percentBasedOnSecurityPrice: BigDecimal? = null, var percentTotal: BigDecimal? = null, var percentPerformanceTotal: BigDecimal? = null)

Profit or loss details of the position.

CustodyPositionValuesDto

data class CustodyPositionValuesDto(var portfolioWeightAccruedInterest: BigDecimal, var amountOnMarket: AmountDto? = null, var amountOnMarketInPortfolioCurrency: AmountDto? = null, var portfolioWeight: BigDecimal? = null, var profitsOrLosses: CustodyPositionValueProfitDto? = null)

Value of the position in the portfolio and in the market.

CustodyTransactionCodeEnumDto

enum CustodyTransactionCodeEnumDto : Enum<CustodyTransactionCodeEnumDto>

Code, which type of transaction is used.

CREDIT - The transaction is credited to the account.
DEBIT - The transaction is debited to the account.
UNIMPORTANT - Other value dates that are not important for the statement of assets (e.g. coupons).

Values: CREDIT,DEBIT,UNIMPORTANT

CustodyTransactionDetailsDto

data class CustodyTransactionDetailsDto(var text: String? = null, var textType: TextTypeEnumDto? = null, var securityType: SecurityTypeDto? = null, var securityTypeClassL1: SecurityTypeDto? = null, var securityTypeClassL2: SecurityTypeDto? = null)

Details of the transaction.

CustodyTransactionDto

data class CustodyTransactionDto(var id: String, var custodyAccountId: String, var transactionKey: String, var dateValue: LocalDate, var dateBooking: LocalDate, var bookingText: String, var documentId: String? = null, var orderNumber: String? = null, var name: String? = null, var description: String? = null, var settlementValue: AmountDto? = null, var rate: BigDecimal? = null, var securityUnit: SecurityUnitTypeEnumDto? = null, var dateTrading: LocalDate? = null, var transactionTypeCode: CustodyTransactionCodeEnumDto? = null, var details: CustodyTransactionDetailsDto? = null, var isin: String? = null, var quantity: BigDecimal? = null, var marketPlace: String? = null, var price: AmountDto? = null)

Transaction of a custody account.

CustodyTransactionSearchRequestDto