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

Package-level declarations

Types

enum AmountValueTypeEnumDto : Enum<AmountValueTypeEnumDto>

Defines the type of amount.

FIXED - Fixed amount
PERCENTAGE - The fee is a percentage of the asset value.
OTHER - The value in the amountUnitOfTime field contains a different value. As a rule, this is a string that can only be displayed.

Values: FIXED,PERCENTAGE,OTHER

data class BrokerageFeeDto(var amount: BigDecimal, var amountUnitOfTime: String, var amountUnitOfTimeType: AmountValueTypeEnumDto, var description: String? = null)

Fee due for the execution of the order. A detailed description of the corresponding fee can be found in the description field, provided this is supported by the provider. This object is only filled if corresponding fees are incurred.

BrokerageLimitDto

data class BrokerageLimitDto(var limitType: LimitTypeEnumDto, var limit: BigDecimal? = null)

Describes the limit of an order. The limit field can only be empty if the type in the limitType field corresponds to the value MARKET_PRICE.

BrokerageOrderDetailReferencesDto

data class BrokerageOrderDetailReferencesDto(var accountId: String, var custodyAccountId: String, var enteredById: String, var placedById: String, var securityId: String, var brokerId: String? = null, var cancelledById: String? = null)

References to accounts and/or persons/processors associated with the order.

BrokerageOrderDetailsDto

data class BrokerageOrderDetailsDto(var action: OrderDetailActionEnumDto, var status: OrderStatusEnumDto, var references: BrokerageOrderDetailReferencesDto, var timeProgression: BrokerageOrderDetailTimeProgressionDto? = null)

Order

BrokerageOrderDetailTimeProgressionDto

data class BrokerageOrderDetailTimeProgressionDto(var placed: OffsetDateTime? = null, var executed: OffsetDateTime? = null, var cancelled: OffsetDateTime? = null, var validFrom: OffsetDateTime? = null, var validUntil: OffsetDateTime? = null)

Describes the chronological sequence of the respective statuses of an order. Depending on the situation, only certain fields are filled.

BrokerageOrderListResponseDto

data class BrokerageOrderListResponseDto(var orders: MutableList<BrokerageOrderResponseObjectDto>, var page: PageDto)

Returns the result list of the search for brokerage orders.

BrokerageOrderRequestDetailsDto

data class BrokerageOrderRequestDetailsDto(var securityId: String, var securityListingId: String, var action: OrderDetailActionEnumDto, var executionType: OrderExecutionTypeEnumDto, var amount: AmountDto, var dateValidUntil: LocalDate, var limit: BigDecimal? = null)

Details of the order

BrokerageOrderRequestDto

data class BrokerageOrderRequestDto(var accountId: String, var custodyAccountId: String, var orderDetails: BrokerageOrderRequestDetailsDto, var enteredById: String? = null, var placedById: String? = null)

Object with the data for an order.

BrokerageOrderResponseDto

data class BrokerageOrderResponseDto(var id: String)

Response for an order

BrokerageOrderResponseObjectDto

data class BrokerageOrderResponseObjectDto(var id: String, var transactionKey: String, var amountQuantityOrValue: BigDecimal, var amountExecuted: BigDecimal, var orderDetails: BrokerageOrderDetailsDto, var amountCurrency: CurrencyDto? = null, var commission: BigDecimal? = null, var fee: BrokerageFeeDto? = null, var limits: BrokerageLimitDto? = null, var securitySymbol: String? = null, var shareRegisterCode: String? = null)

Object that represents a brokerage order.

BrokerageOrderSearchRequestDto

data class BrokerageOrderSearchRequestDto(var accountId: String? = null, var custodyAccountId: String? = null, var securityId: String? = null, var action: OrderDetailActionEnumDto? = null, var limitType: LimitTypeEnumDto? = null, var status: OrderStatusEnumDto? = null, var dateStart: LocalDate? = null, var dateEnd: LocalDate? = null)

Object with parameters for searching for orders

LimitTypeEnumDto

enum LimitTypeEnumDto : Enum<LimitTypeEnumDto>

Type of limit:

STOP_LOSS - A transaction may not be executed at a price that is below the specified limit.
MARKET_PRICE - Means that an immediate purchase or sale at the best price should be carried out regardless of the limit.
LIMITED - A purchase, where the price may not exceed the limit, or a sale, where the proceeds may not be below the limit.

Values: STOP_LOSS,MARKET_PRICE,LIMITED

OrderDetailActionEnumDto

enum OrderDetailActionEnumDto : Enum<OrderDetailActionEnumDto>

Action to be carried out when the order is placed. This can be the following values:

BUY - Purchase
SELL - Selling
SUBSCRIPTION - Subscription
REDEMPTION - Redemption

OrderExecutionTypeEnumDto

enum OrderExecutionTypeEnumDto : Enum<OrderExecutionTypeEnumDto>

Execution type of the order.

MARKET_PRICE - Execute it at the current market price.
LIMIT - A limit order is a buy or sell order at a specific price.The limit order is only executed if it can be executed at the limit price or at a more favorable price for the investor.
STOP - A stop order is a buy or sell order that is executed as soon as a certain price is reached.
STOP_LIMIT - The stop limit order is used to buy or sell at a certain price when the price of the financial instrument reaches a defined stop price.

Values: MARKET_PRICE,LIMIT,STOP,STOP_LIMIT

OrderStatusEnumDto

enum OrderStatusEnumDto : Enum<OrderStatusEnumDto>

Describes the current status of the order. Values: ENTERED,ACCEPTED,EXECUTED,PARTIALLY_EXECUTED,SETTLED,PARTIALLY_SETTLED,REJECTED,CANCELLED,PARTIALLY_CANCELLED,EXPIRED,REVERTED_CANCELLATION_BY_BANK,NEEDS_ADAPTATION,ORDER_CONFIRMED_REQUIRED